Skip to content

Commit db08438

Browse files
committed
add contribution guidelines
1 parent 3195ae6 commit db08438

File tree

2 files changed

+22
-1
lines changed

2 files changed

+22
-1
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Contribution guidelines
2+
3+
Before making a pull request, please make sure of the following:
4+
* The tutorial(s) you want to add do not already exist
5+
* Your tutorial is correctly placed under the appropriate language/technology
6+
* Improvements of the same tutorial are encouraged!
7+
* The pull request needs to have a descriptive title
8+
* If the language/technology of your tutorial does not exist, feel free to create a new entry in table of contents
9+
* Make a separate pull request for each of the tutorial
10+
* Use the following format `[Title](!link_to_tutorial)`
11+
* If your tutorial is a multi-part series, use the following format:
12+
* ```
13+
* Title
14+
* [Part 1](!link_to_part_1)
15+
* [Part 2](!link_to_part_2)
16+
```
17+
* Check the spelling and grammar
18+
* Remove any trailing whitespaces
19+
* 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
20+
21+
Thank you for your suggestions! If you think there is anything to improve with the guidelines, please contact me at <tuvtran97@gmail.com>

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
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.
44

5-
To get started, simply fork this repo. Please refer to [CONTRIBUTION.md](CONTRIBUTION.md) for contribution guidelines.
5+
To get started, simply fork this repo. Please refer to [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines.
66

77
## Table of Contents:
88
* [C/C++](#cc)

0 commit comments

Comments
 (0)