project-based-learning/CONTRIBUTING.md

23 lines
1.2 KiB
Markdown
Raw Normal View History

2017-04-28 05:32:31 +00:00
# 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
2017-04-28 05:40:11 +00:00
* Use the following format `[Title](link_to_tutorial)`
2017-04-28 05:32:31 +00:00
* If your tutorial is a multi-part series, use the following format:
2017-04-28 05:34:19 +00:00
```
2017-04-28 05:32:31 +00:00
* Title
2017-04-28 05:38:35 +00:00
* [Part 1](link_to_part_1)
* [Part 2](link_to_part_2)
2017-04-28 05:32:31 +00:00
```
* Check the spelling and grammar
* Do the work, write good commit messages, and read the CONTRIBUTING file if there is one
2017-04-28 05:32:31 +00:00
* 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
2017-04-28 05:38:35 +00:00
Thank you for your suggestions! If you think there is anything to improve with the guidelines, please contact me at <tuvtran97@gmail.com>