diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..37499e3 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,21 @@ +# 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)` +* 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) + ``` +* Check the spelling and grammar +* 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 \ No newline at end of file diff --git a/README.md b/README.md index b526083..50278b9 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ A list of programming tutorials in which learners build an application from scratch. These tutorials are divided into different primary programming languages. Some have intermix technologies and languages. -To get started, simply fork this repo. Please refer to [CONTRIBUTION.md](CONTRIBUTION.md) for contribution guidelines. +To get started, simply fork this repo. Please refer to [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines. ## Table of Contents: * [C/C++](#cc)