|
1 |
| -##Contributing |
| 1 | +##🌟Contributing |
2 | 2 |
|
3 |
| -**General Rules** |
| 3 | +###📜General Rules |
4 | 4 |
|
5 |
| --As much as possible, try to followthe existing format of markdown and code. |
6 |
| --Don't forget to run`npm run lint` and`npm test` before submitting pullrequests. |
7 |
| --Make sure that**100%** of your code is covered by tests. |
| 5 | +-🖋️ Followthe existing format of markdown and code as much as possible. |
| 6 | +-🔍 Run`npm run lint` and`npm test` before submittingyourpullrequest. |
| 7 | +-✅ Ensure**100%** of your code is covered by tests. |
8 | 8 |
|
9 |
| -**Contributing New Translation** |
| 9 | +###🌍ContributingaNew Translation |
10 | 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](http://www.lingoes.net/en/translator/langcode.htm). |
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. |
| 11 | +- 📄 Create a new`README.xx-XX.md` file for your translation alongside the main`README.md`. Use[locale and country/region codes](http://www.lingoes.net/en/translator/langcode.htm) for naming (`xx-XX`), like`en-US`,`zh-CN`,`ko-KR`, etc. |
| 12 | +- 📁 Translate any relevant sub-folders by creating`README.xx-XX.md` files in each. |
16 | 13 |
|
17 |
| -**Contributing NewAlgorithms** |
| 14 | +###📐ContributingaNewAlgorithm |
18 | 15 |
|
19 |
| -- Make your 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**. |
| 16 | +- 🎯 Keep pull requests**specific** and**focused**. For example, rather than submitting "several sorting algorithms," submit them individually, such as one PR for "Quick Sort" and another for "Heap Sort." |
| 17 | +- 📝 Include a**README.md** file for each algorithm with a**detailed explanation** and**links to additional resources**. |
| 18 | +- 💬 Use**comments** in your code to describe each step and clarify your logic. |