Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: trekhleb/javascript-algorithms
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: master
Choose a base ref
...
head repository: aniruddhaadak80/javascript-algorithms
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: patch-1
Choose a head ref
Able to merge. These branches can be automatically merged.
  • 1 commit
  • 1 file changed
  • 1 contributor

Commits on Nov 1, 2024

  1. Update CONTRIBUTING.md 

    Enhance CONTRIBUTING guidelines with structure and visual clarity.
    @aniruddhaadak80
    aniruddhaadak80 authored Nov 1, 2024

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature.
    GPG key ID: B5690EEEBB952194
    Verified
    Learn about vigilant mode
    Copy the full SHA
    8175fb0 View commit details
Showing with 12 additions and 19 deletions.
  1. +12 −19 CONTRIBUTING.md
31 changes: 12 additions & 19 deletions CONTRIBUTING.md
View file
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.