Skip to content

Latest commit

 

History

History
59 lines (45 loc) · 2.57 KB

contributing.md

File metadata and controls

59 lines (45 loc) · 2.57 KB
Raw

How to Contribute

  • First of all, you'll need a GitHub account.
  • Point your browser to the README.md file
  • Click on the edit icon
  • Edit the file and add whatever you feel appropriate. Make sure you follow the CoC guidelines!
  • Create a new commit (save the changes) with your work. Be descriptive and concise!
  • Create a Pull Request (prepare to send your changes to the original repository)
  • Review your changes and if everything looks good... Send your changes!

If everything looks good, your change will be integrated to the list soon enough.

Tips and content formatting

  • Make sure your suggestion isn't already there
  • New categories or improvements to the existing categorization are welcome
  • Check your spelling and grammar (nobody is perfect anyway)
  • Make sure your text editor is set to remove trailing whitespace
  • The pull request and commit should be clear of what has been updated

When adding a new language, make sure that:

  1. Is ordered alphabetically
  2. follows the following format:
* [Language](http://language.com), brief description of this language. `OS SUPPORTED | SEPARATED BY | A PIPE` `RELEVANT-TAG` `ANOTHER-RELEVANT-TAG` `LICENSE`
  • When adding tool/library, make sure that:
  1. Is ordered alphabetically
  2. follows the following format:
* [Library-or-tool](http://Library-or-tool.com), brief description of the Library-or-tool

Note the missing dot (.) at the end of the line

When adding a anything else, make sure that:

  1. Is added to the bottom of the list
  2. follows the following format:
* [Title](http://url.com), brief description of the link added

Note the missing dot (.) at the end of the line

Here are a couple of articles that might come in handy while working: