Skip to content

Latest commit

 

History

History
34 lines (26 loc) · 2.46 KB

contributing.md

File metadata and controls

34 lines (26 loc) · 2.46 KB
Raw

Contribution Guidelines

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.

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

How to Contribute?

You'll need a GitHub account!

  1. Access the GitHub page: https://github.com/Liquid-Legal-Institute/Legal-Text-Analytics
  2. Click on the readme.md file: Step 2 Click on Readme.md
  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!

Updating your Pull Request

Sometimes, a maintainer of an awesome list will ask you to edit your Pull Request before it is included. This is normally due to spelling errors or because your PR didn't match the CLP principles.

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

Credits These contributing guidelines are taken from awesome's contributing guidelines