Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
29 lines (27 loc) · 1.52 KB

CONTRIBUTING.md

File metadata and controls

29 lines (27 loc) · 1.52 KB

Contribution guidelines

Before making a pull request, please make sure of the following:

  • The tutorial(s) you want to add do not already exist
  • Your tutorial is correctly placed under the appropriate language/technology
  • Improvements of the same tutorial are encouraged!
  • The pull request needs to have a descriptive title
  • If the language/technology of your tutorial does not exist, feel free to create a new entry in table of contents
  • Make a separate pull request for each of the tutorial
  • Use the following format [Title](link_to_tutorial) [guide]
  • Append exactly one resource tag at the end of each new tutorial entry: [guide] [video] [course] [book] [repo]
  • If your tutorial is a multi-part series, use the following format: 
        * Title
        * [Part 1](link_to_part_1)
        * [Part 2](link_to_part_2)
  • Valid single-entry examples: 
        * [Build a REST API](https://example.com) [guide]
    * [Build a Game Engine](https://example.com) [video]
    * [Create a Compiler](https://example.com) [repo]
  • Check the spelling and grammar
  • Do the work, write good commit messages, and read the CONTRIBUTING file if there is one
  • Remove any trailing whitespaces
  • Links must be pointing straight to the tutorials, no URL shorteners. However, if the URL is too long (more than 80 characters), Google URL Shortener is allowed

Thank you for your suggestions! If you think there is anything to improve with the guidelines, please contact me at tuvtran97@gmail.com