Welcome to Yoke! This document is a guideline about how to contribute to Yoke. If you find something incorrect or missing, please leave comments / suggestions.
Please make sure to read and observe our Code of Conduct.
The Yoke project is proud to be an OpenSource project and welcomes participation and contributions from the community via github's issue tracker and/or pull requests.
To create a pull request:
- fork the repository
- open a pull request against
main
Commit messages should be meaningful as they will end up in the changelog.
Please use the format: <component or package affected>: message.
Messages containing the string breaking change will trigger a minor version bump.
Minor version bumps are used to signal breaking changed until the project reaches v1.0.0 at which point semantic versioning will be used proper.
We use GitHub Issues and Pull Requests for trackers.
If you find a typo in document, find a bug in code, or want new features, or want to give suggestions, you can open an issue on GitHub to report it. Please follow the guideline message in the issue template.
If you want to contribute, please follow the contribution workflow and create a new pull request. If your PR contains large changes, e.g. component refactor or new components, please write detailed documents about its design and usage.
Note that a single PR should not be too large. If heavy changes are required, it's better to separate the changes to a few individual PRs.
All code should be well reviewed by one or more committers.
N/A. Will be updated once we have a slack channel or discord setup.
Contact the maintainers via the issue tracker.