If you have any doubt on the contributing guide, please feel free to state it clearly in an issue.
New implementations in other languages for existing solutions are welcome.
Contributions improving the documentation(README.md files) are welcome.
New questions and topics are also welcome.
Follow the directory structure of the project.
.
├── ...
├── Topic 1 # DP,Bitmasking..etc
│ ├── Problem 1 # N-Queens, Kadane
│ │ ├── lang 1_implementation # Python, C++, C, Java, JS
│ │ ├── lang 2_implementation
│ │ └── Readme # Solution Explanation
│ ├── Problem 2
│ │ ├── ...
│ │ ├── ...
│ │ └── Readme
│ └── Problem 3
| │ ├── ...
│ | ├── ...
| │ └── Readme
│ └── ...
└── ...
We appreciate any contribution, from fixing a grammatical error in a comment to implementing complex algorithms. Please read this section if you are contributing your work.
We want your code to be easily understood by others, so make sure:
- You comment your code, with the working of the algorithm
- Link any reference that helped you with the code, for example, a wikipedia page.
- Help your reader by using descriptive names that can help you remove redundant comments.
- Avoid single letter variable names, unless their scope is only a few lines.
- Avoid acronyms.
- Avoid taking user inputs. Hardcode a value instead. This is to avoid confusion while running the program.
For example, avoid
number = int(input()) # Don't do this.instead, do:
number = 10If you can't avoid user input, make sure that the user will have a clear idea of what to give as the input, and does not face a blank prompt.
5. Most importantly, make sure your code works, and do provide an example that shows its working.