If you'd like to contribute to this repository, great! If you have found any issues or would like to submit a PR follow, the instructions below:
If you find a bug in the source code of one of the algorithms or test files you can help by submitting an issue, or even better you can submit a PR. Issue format is fairly relaxed just be very descriptive.
- Make your changes in a new branch:
git checkout -b new-branch-name master- Try and adhere to the Google Style Guide's formatting section for the language you're using
If the formatting doesn't match the guide perfectly it's fine, just make sure your formatting is consistent
- Make sure your commit message follows the commit message guidelines below
- Push your branch to GitHub:
git push origin new-branch-name- Open up a PR on GitHub and that's it!
When adding an algorithm or datastructure to the repository, providing test.in and test.out stdin/stdout files demonstrating a procedure's correct output is a plus! These don't need to be crazy extensive, just enough to demonstrate some edge cases if necessary.
Readable commit messages are extremely helpful and the format for commit messages in this repository is very simple:
commitType(resourceModified): brief explanation of the modifications you made
The commitType is a brief descriptor of the type of work you're committing, it can be one of the following:
- algo: Algorithm or datastructure source code
- fix: Fixes to algorithm or datastructure source code
- test: Adding or correcting stdin test files
- docs: Documentation changes only
- refactor: A code change that neither fixes a bug nor adds a feature
- chore: Trivial modifications that don't affect correctness, structure, or documentation
See contributing.json for more specifics on the commit message tests that will be run on a newly opened PR.