First of all, thank you for considering contributing to this project! Any sort of contributions are very welcome and help the project grow. Before starting, please read the following guidelines.
You can contribute in many ways, such as
If you find bugs, have ideas for features or just overall suggestions on how to improve this project, feel free to create an issue about it and I'll make sure to read it!
If you'd like to introduce new features yourself, I adopted the Github Flow to this project, this means each new feature is worked on its specific branch and then merged onto master. That being said, here are the general steps to contribute code
- Fork the repository. Fork this project to your Github Account, after that you can clone it to your machine using
git clone <project-url> - Create a branch. - Since we use the Github Flow, features being worked on have their own branch, to do this, simply run
git checkout -b <feature-or-fix-name>- Make any changes you'd like. Please do make sure any changes are documented, prefferably with proper XML comments explaining what your implementation does.
- Test your changes. Make sure your changes work properly and don't cause any issues.
- After you're done, create a pull request. After you pushed your commits to your awesome feature branch, create a pull request for me to review your code, if everything looks good then your awesome feature is now part of this codebase!
Any contribution you make, no matter how big or small, means a lot to me and knowing you've shown interest in the project gives me more motivation to work on it!