|
| 1 | +# Contributing to Dart Frog |
| 2 | + |
| 3 | +First off, thanks for taking the time to contribute! 🎉👍 |
| 4 | + |
| 5 | +This project is opinionated and follows patterns and practices used by the team at [Very Good Ventures][very_good_ventures_link]. **At this time, we welcome bug tickets but will not be accepting feature requests because the roadmap and scope of this project is still being defined.** In the future, we may support additional, more feature-rich templates but at this time we would ask that issues be reserved for bugs only. |
| 6 | + |
| 7 | +## Creating a Bug Report |
| 8 | + |
| 9 | +We highly recommend [creating an issue][bug_report_link] if you have found a bug rather than immediately opening a pull request. This lets us reach an agreement on a fix before you put significant effort into a pull request. Please use the built-in [Bug Report][bug_report_link] template and provide as much information as possible including detailed reproduction steps. Once one of the package maintainers has reviewed the issue and an agreement is reached regarding the fix, a pull request can be created. |
| 10 | + |
| 11 | +## Creating a Pull Request |
| 12 | + |
| 13 | +Before creating a pull request please: |
| 14 | + |
| 15 | +1. Fork the repository and create your branch from `main`. |
| 16 | +1. Install all dependencies (`dart pub get`). |
| 17 | +1. Squash your commits and ensure you have a meaningful, [semantic][conventional_commits_link] commit message. |
| 18 | +1. Add tests! Pull Requests without 100% test coverage will not be approved. |
| 19 | +1. Ensure the existing test suite passes locally. |
| 20 | +1. Format your code (`dart format .`). |
| 21 | +1. Analyze your code (`dart analyze --fatal-infos --fatal-warnings .`). |
| 22 | +1. Create the Pull Request. |
| 23 | +1. Verify that all status checks are passing. |
| 24 | + |
| 25 | +While the prerequisites above must be satisfied prior to having your |
| 26 | +pull request reviewed, the reviewer(s) may ask you to complete additional |
| 27 | +work, tests, or other changes before your pull request can be ultimately |
| 28 | +accepted. |
| 29 | + |
| 30 | +[conventional_commits_link]: https://www.conventionalcommits.org/en/v1.0.0 |
| 31 | +[bug_report_link]: https://github.com/VeryGoodOpenSource/dart_frog/issues/new?assignees=&labels=bug&template=bug_report.md&title=fix%3A+ |
| 32 | +[very_good_ventures_link]: https://verygood.ventures |
0 commit comments