Skip to content

Latest commit

 

History

History
28 lines (21 loc) · 2.27 KB

CONTRIBUTING.md

File metadata and controls

28 lines (21 loc) · 2.27 KB

Contribution Guide for data-structures-all-langs

Thank you for taking time out to learn the best practices for contributing to this repo! Your contributions will potentially help thousands of developers on their journeys to understand data structures intuitively. Please, read through carefully and feel free to open an issue if something is not clear.

Before you start coding

If you are interested in contributing a feature, please file an issue first. Wait for a project maintainer to respond before you spend time coding.

If you wish to work on an existing issue, please add a comment saying so, as someone may already be working on it. A project maintainer may respond with advice on how to get started. If you're not sure which issues are available, search for issues with the help wanted label.

Copied this paragraph from vscode-go.

Guidelines

As a contributor you can:

  • Implement a data structure in a language that doesn't exist
  • Improve any implementation
  • Improve the READMEs explaining any data structure (NO SPAMS, PLS)

Adding/Editing a README

  • Follow the TEMPLATE-ONE file for data structures with single implementations
  • Follow the TEMPLATE-TW0 file for data structures with multiple implementations

Adding/Editing a Coding File

  • Coding file should be created a directory that looks like data-structures-all-langs/name.of.data.structure/programming.language/name.of.file
  • Mark yourself as the author at the top of the file like this. Find the best way to do this for the langauge you are using
  • Add a comment explaining the parameters and the return type of each method
  • Add driver code (i.e. code in the "main" function to test the implementation)

Creating PRs

  • The relevant issue links should be referenced in the PR