You want to contribute to Algorithms and Data Structures? Cool! Feel welcome and read the following sections in order to know what and how to work on this repository. If you get into a problem, make an issue, and we'll respond!
Following these guidelines helps to communicate that you respect the time of the everyone managing and contributing to this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.
This is repository is aimed towards being a go to section for all new students to reference code from. Help us do that by adding algorithms and Data Structure implementations in the Languages you love to use!
With great code, comes great responsibilities!
These are some general rules so everyone can contribute with no conflicts of any kind, either in code, or between contributors!
⚠️ Fork the repo make a new branch name as your username and do changes else it will not be accepted.⚠️ Don't update MAIN README in case of new language addition, it would be updated once your pull request is accepted.⚠️ Don't update and add name in CONTRIBUTORS file it would be added if your pull request is accepted ASAP.⚠️ For new Issue, make sure that you add in a good level detail for the issue you find in the code and also add path to the bug file.
Developers: Its not a bug its a feature 😄 Programmers: Its not a feature its LOGICAL ERROR 😎
-
Ensure that the code you write contains proper comments and is formatted as the general convention of the language
- C code must adhere to GNU Standards
- C++ code must adhere to Google Coding Style
- Java Code must adhere to Google Coding Style
- Javascript code must adhere to JSLint Quality
- Python code must serve to PEP8 convention
- Kotlin Code must adhere to Official Conventions
-
Maintain same directory structure as recommended in MAIN README.
-
Make sure your code has Proper Identation so that it would be easy for fellow programmers to read your code.
-
Add new language you love except already present but its mandatory for you to add a Algorithm or a Data Structure code of new language.
-
Each code snippet should contain some testing inputs and output to make sure that your code works well and specify where it fails.
Find bugs in our code and create issue.
See bugs issues fix bugs and create pull request it will be accepted in 24 hours ASAP.
Hola guys do you love to write documentation so following instructions are for you.
- Maintain same heading structure for the docs as recommended in MAIN README.
- Don't update online wiki or wiki file.
- Add name same as algorithm or data structure name you are adding.
- DOCS should be added in docs directory only.
Suggest new feature you think should be added for better open source understanding of Algorithms and Data Structures by creating a issue.