Skip to content
This repository was archived by the owner on May 14, 2023. It is now read-only.

Latest commit

 

History

History
28 lines (19 loc) · 1.56 KB

CONTRIBUTING.md

File metadata and controls

28 lines (19 loc) · 1.56 KB

Contributing to the Adaptive Breakpoints package

Thank you for your interest in contributing to the adaptive_breakpoints package! We love receiving contributions, and your work helps the whole community. This doc will walk you through the easiest way to make a change and have it submitted to the adaptive_breakpoints package.

Developer workflow

The easiest workflow for adding a feature/fixing a bug is to test it out on the example app in this repo.

Environment

  1. Fork the material-components-flutter-adaptive repo on github.
  2. Clone your fork of the material-components-flutter-adaptive repo.
  3. Build and run the example app in example/lib/main.dart (from the example/ directory, use $ flutter run).

Development

  1. Make the changes to your local copy of the adaptive_breakpoints package, testing the changes in the example app.
  2. Write a unit test for your change, if possible, in one of the files in test/.
  3. Update the CHANGELOG.md with a new version number, and a description of the change you're making.
  4. Update the version: in the pubspec.yaml file to your new version.

Review

  1. Make sure all the existing tests are passing by using the following command (from the root of the project): $ flutter test test/.
  2. Create a PR to merge the branch on your fork into adaptive_breakpoints/master.
  3. Add JoseAlba as reviewer on the PR. I will take a look and add any comments. When the PR is ready to be merged, we will merge it and update the package.