👍 🎉 First off, thanks for taking the time to contribute! 🎉 👍
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners and former collaborators of this repository before making a change.
The Issues section is a good start to check what is needed. Alternatively, you can contribute with small changes, refactoring or improvements that don't have a related issue, in these cases you can just open a pull request.
Please note we have a code of conduct, please follow it in all your interactions with the project. You can read the code of conduct at https://github.com/paulodiovani/hacktoberrank/blob/master/CODE_OF_CONDUCT.md.
- Add a description about what the pull request changes or fixes
- Ensure the pull request branch can be run following the instructions on README and won't break build and tests in CI.
- Write unit tests for new features.
- New e2e tests are also welcome but can be written on a separate PR.
- Update the README.md with details of changes, if any, including setup/run instructions, interface, etc.
- Be kind when discussing changes on pull requests.
- Pull Requests are required to be approved at least once to be merged. This process can take a while so be patient.
- Report bugs or suggest features by writing issues
- Review and test pull requests by other contributors
- Spread the word about this project so we can achieve the challenge 🗣