hxx/javascript-algorithms
1
0
Fork 0
mirror of https://github.moeyy.xyz/https://github.com/trekhleb/javascript-algorithms.git synced 2024-11-10 11:09:43 +08:00
Code Issues Packages Projects Releases Wiki Activity
5adca66282
javascript-algorithms/CONTRIBUTING.md
Oleksii Trekhleb 8da83cd9dc Update contribution guide.
2018-07-26 15:33:00 +03:00

1.0 KiB
Raw Blame History

Contributing

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.

Contributing 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. 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.

Contributing New Algorithms

  • 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.