Create a contribute guideline.
Here is an example.
Contributing to Bricks
Thanks for taking the time to contribute! 🧱🚀
The following is a set of guidelines for contributing to Bricks.
These are mostly guidelines, not rules. Use your best judgment,
and feel free to propose changes to this document in a pull request.
Proposing a Change
If you intend to change the public API, or make any non-trivial changes
to the implementation, we recommend filing an issue.
This lets us reach an agreement on your proposal before you put significant
effort into it.
If you’re only fixing a bug, it’s fine to submit a pull request right away
but we still recommend to file an issue detailing what you’re fixing.
This is helpful in case we don’t accept that specific fix but want to keep
track of the issue.
Creating a Pull Request
Before creating a pull request please:
- Fork the repository and create your branch from
master
.
- Install all dependencies (
flutter packages get
or pub get
).
- Squash your commits and ensure you have a meaningful commit message.
- If you've changed the public API, make sure to update/add documentation.
- Create the Pull Request.
- Verify that all status checks are passing.
While the prerequisites above must be satisfied prior to having your
pull request reviewed, the reviewer(s) may ask you to complete additional
design work, tests, or other changes before your pull request can be ultimately
accepted.
License
By contributing to Bricks, you agree that your contributions will be licensed
under its MIT license.