data-structure-typed/CONTRIBUTING.md
2023-10-11 23:14:35 +08:00

733 B

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 Data Structures

  • Make your pull requests to be specific and focused. Instead of contributing "several data structures" all at once contribute them all one by one separately (i.e. one pull request for "RBTree", another one for "AATree" and so on).
  • Provide README.md for each of the data structure with explanations of the algorithm and with links to further readings.
  • Describe what you do in code using comments.