Skip to content

Latest commit

 

History

History
61 lines (43 loc) · 2.37 KB

CONTRIBUTING.md

File metadata and controls

61 lines (43 loc) · 2.37 KB
Raw

Contributing to Very Good Analysis

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

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:

  1. Fork the repository and create your branch from main.
  2. Install all dependencies (dart pub get).
  3. Squash your commits and ensure you have a meaningful commit message.
  4. If you’ve fixed a bug or added code that should be tested, add tests! Pull Requests without 100% test coverage will not be approved.
  5. Ensure the test suite passes.
  6. If you've changed the public API, make sure to update/add documentation.
  7. Format your code (dart format .).
  8. Analyze your code (dart analyze . --fatal-infos).
  9. Create the Pull Request.
  10. 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.

Releasing new versions

Every snapshot of a version is saved on its own yaml file under the name pattern: lib/analysis_options.<version>.yaml.

Release a new version

  1. Run the bump_version script with the desired new version as an argument:
dart tool/bump_version/main.dart <version>

Where <version> is the new version to be released in the format x.y.z.

This script will:

  • Copy the most recent yaml to a new one with the new desired version.
  • Include that file on the main yaml file lib/analysis_options.yaml.
  1. Update the README.md exclusion table, refer to the "Exclusion Reason Table 🗞️👨‍⚖️" documentation for more information.
  2. Open a pull request with the proposed changes.