First off, thanks for taking the time to contribute to my project! It'll be of great help fr me !
Now please, take a moment to be sure your contributions make sense to everyone else. Remember : these are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
Found a problem? Want a new feature? First check if your issue or idea has already been reported. Don't? Then please just open a new clear and descriptive issue.
Pull requests are the greatest contributions, so be sure they are focused in scope, and do avoid unrelated commits.
- Fork it!
- Clone your fork:
git clone https://github.com/<your-username>/<project-name> - Navigate to the newly cloned directory:
cd project-nam - Create a new branch for the new feature, a branch for each one new feature please :
git checkout -b my-new-feature - Install the tools necessary for development:
npm install - Make your changes.
- Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request with full remarks documenting your changes.
Other then master, there are 2 main branches : JAVA_DEVELOP, KOTLIN_DEVELOP, I've decided to keep both languages, (Java too for exercising, while Kotlin is still work in progress) : branch from one of the *_DEVELOP branches of the 2. Currently master is still in java.
Every time you write a test, remember to answer all the questions:
- What are you testing?
- What should it do?
- What is the actual output?
- What is the expected output?
- How can the test be reproduced?