Skip to content

Latest commit

 

History

History
67 lines (53 loc) · 2.54 KB

CONTRIBUTING.md

File metadata and controls

67 lines (53 loc) · 2.54 KB
Raw

Contributing

Checks ossf scorecard

Thank you for your interest in contributing! Your work can help many developers.

Updating an existing package

Note All packages target Flutter's beta channel

Development

  1. Fork the repo and clone it to your local machine, creating a branch to work on.
  2. Make the changes.
  3. If there exists an example app under /example, use it to manually test your changes.
  4. Write a unit test for your change, under test/.
  5. Update the CHANGELOG.md using cider. For example: 
    cider log changed|added|fixed|removed 'Added a schmilblick'
  6. Make sure all the existing tests are passing with flutter test.
  7. Make sure the repo is formatted using dart format ..
  8. Commit the changes to your branch and push.

That's it! Releasing is done by team members, see the Releasing section below.

Review

  1. Create a PR to merge your branch into flutter-packages/main.
  2. A reviewer will be automatically assigned.

Releasing

Note For package maintainers only

Tip To run a command for all subpackages, use for d in ./packages/*; do (cd "$d" && <command>); done

  1. Bump pubspec.yaml's version with:

    cider bump major|minor|patch

  2. Update the CHANGELOG.md with:

    cider release

  3. Publish to pub.dev with:

    flutter pub publish

  4. Create and push a commit and tag

    git commit -am "bump \`$(basename $PWD)\` to $(cider version)"
git tag "$(basename $PWD)-$(cider version)"
git push --all

Adding a new package

New packages should be accounted for in: