Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update CONTRIBUTING.md #1457

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update CONTRIBUTING.md #1457

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 12 additions & 19 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,25 +1,18 @@
## Contributing
## 🌟 Contributing

**General Rules**
### 📜 General Rules

- As much as possible, try to follow the existing format of markdown and code.
- Don't forget to run `npm run lint` and `npm test` before submitting pull requests.
- Make sure that **100%** of your code is covered by tests.
- 🖋️ Follow the existing format of markdown and code as much as possible.
- 🔍 Run `npm run lint` and `npm test` before submitting your pull request.
- ✅ Ensure **100%** of your code is covered by tests.

**Contributing New Translation**
### 🌍 Contributing a New Translation

- Create new `README.xx-XX.md` file with translation alongside with
main `README.md` file where `xx-XX` is [locale and country/region codes](http://www.lingoes.net/en/translator/langcode.htm).
For example `en-US`, `zh-CN`, `zh-TW`, `ko-KR` etc.
- You may also translate all other sub-folders by creating
related `README.xx-XX.md` files in each of them.
- 📄 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.
- 📁 Translate any relevant sub-folders by creating `README.xx-XX.md` files in each.

**Contributing New Algorithms**
### 📐 Contributing a New Algorithm

- Make your pull requests to be **specific** and **focused**. Instead of
contributing "several sorting algorithms" all at once contribute them all
one by one separately (i.e. one pull request for "Quick Sort", another one
for "Heap Sort" and so on).
- Provide **README.md** for each of the algorithms **with explanations** of
the algorithm and **with links** to further readings.
- Describe what you do in code using **comments**.
- 🎯 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."
- 📝 Include a **README.md** file for each algorithm with a **detailed explanation** and **links to additional resources**.
- 💬 Use **comments** in your code to describe each step and clarify your logic.