With these guidelines, we hope to make contributing to this project as easy as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
We are sorry if, since today, contributing to Pock was such a mess.
We use GitHub to host code, track issues, suggest new feature requests, and review pull requests.
We use GitHub Issues to track public bugs and feature requests. Report a bug or suggest new features by opening a new issue.
Please, adopt the issues template based on your request. Any issue that does not conform to the project's templates will be closed.
Pull requests are the best way to propose changes to the codebase. All code changes happen through Pull requests.
Follow the steps below to create a pull request:
- Fork the repo and create your branch from
main. - Follow the instructions to set up your local development environment.
- Implement your code.
- If you've changed APIs, remember to update the documentation.
- Issue the pull request.
By contributing, you agree that your contributions will be licensed under its MIT License. Feel free to contact the maintainers if that's a concern.
This document was adapted from the open-source contribution guidelines template from briandk