Skip to content

contributing.md

Latest commit

 

History

History
54 lines (35 loc) · 2.89 KB

contributing.md

File metadata and controls

54 lines (35 loc) · 2.89 KB

Contribution Guidelines

A. Joining the project

The project is open to be joined by every member of the Liquid Legal Institute. Irrespective of membership, we welcome external suggestions for improvements and exchange. Happy to exchange.

B. Suggesting changes

There's two ways to suggest a change:

  • If you suggest a change to a text/code file in the repository, you can create a pull request and directly suggest the edit thereby.
  • For all other changes or if you do not have an GitHub account, you can drop us a line (see end of this file)

1. Pull requests

a. The pull request should have a useful title

Pull requests with Update readme.md as title are not informative enough. Write about what additions you've made and why do you think it is useful.

b. Guidelines

  • Make an individual pull request for each suggestion
  • Use title-casing (AP style)
  • Use the following format: [Relevant Link](link)
  • Link additions should be added to the bottom of the relevant category
  • New categories or improvements to the existing categorization are welcome
  • Check your spelling and grammar
  • Make sure your text editor is set to remove trailing whitespace
  • The pull request and commit should have a useful title

c. How to Contribute?

You'll need a GitHub account!

  1. Access the GitHub page: https://github.com/Liquid-Legal-Institute/eSignature
  2. Click on the file you want to edit.
  3. Now click on the edit icon. Step 3 - Click on Edit
  4. You can start editing the text of the file in the in-browser editor. Make sure you follow guidelines above. You can use GitHub Flavored Markdown. Step 4 - Edit the file
  5. Say why you're proposing the changes, and then click on "Propose file change". Step 5 - Propose Changes
  6. Submit the pull request!

d. Updating your Pull Request

Sometimes, a maintainer of an awesome list will ask you to edit your Pull Request before it is included.

Here is a write up on how to change a Pull Request, and the different ways you can do that.

Credits The pull request part of these contributing guidelines is based on awesome's contributing guidelines.

2. Contact us via email

You can reach out to the project team via LLI's official office email address: info@liquid-legal-institute.org.