Skip to content

Commit 324e761

Browse files
committedJul 26, 2018
Update contribution guide.
1 parent b79fc05 commit 324e761

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed
 

‎CONTRIBUTING.md

+20-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,25 @@
11
## Contributing
22

3+
**General Rules**
4+
35
- As much as possible, try to follow the existing format of markdown and code.
46
- Don't forget to run `npm run lint` and `npm test` before submitting pull requests.
57
- Make sure that **100%** of your code is covered by tests.
6-
- If you're adding **new** algorithms or data structures please provide **README.md** for each of them **with explanations** of the algorithm and **with links** to further readings.
8+
9+
**Contributing New Translation**
10+
11+
- Create new `README.xx-XX.md` file with translation alongside with
12+
main `README.md` file where `xx-XX` is locale and country/region codes.
13+
For example `en-US`, `zh-CN`, `zh-TW`, `ko-KR` etc.
14+
- You may also translate all other sub-folders by creating
15+
related `README.xx-XX.md` files in each of them.
16+
17+
**Contributing New Algorithms**
18+
19+
- Make you pull requests to be **specific** and **focused**. Instead of
20+
contributing "several sorting algorithms" all at once contribute them all
21+
one by one separately (i.e. one pull request for "Quick Sort", another one
22+
for "Heap Sort" and so on).
23+
- Provide **README.md** for each of the algorithms **with explanations** of
24+
the algorithm and **with links** to further readings.
25+
- Describe what you do in code using **comments**.

0 commit comments

Comments
 (0)
Please sign in to comment.