Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,12 @@
## Checklist

Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes (`[x]`).
This will ensure a smooth and quick review process. Updating the `pubspec.yaml` and changelogs is not required.
This will ensure a smooth and quick review process.

- [ ] I read the [Contributor Guide] and followed the process outlined there for submitting PRs.
- [ ] My PR includes unit or integration tests for *all* changed/updated/fixed behaviors (See [Contributor Guide]).
- [ ] All existing and new tests are passing.
- [ ] I updated the version in `pubspec.yaml` and `CHANGELOG.md`.
- [ ] I updated/added relevant documentation (doc comments with `///`).
- [ ] The analyzer (`flutter analyze`) does not report any problems on my PR.
- [ ] I read and followed the [Flutter Style Guide].
Expand Down
14 changes: 10 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,18 +182,24 @@ melos run analyze
melos run format
```

Before opening a Pull-Request, **please increase the build number in the `pubspec.yaml`
### 5.3 Update version and changelog

Before opening a Pull-Request, **please increase the version number in the `pubspec.yaml`
and create a new entry in the `CHANGELOG.md` describing the change**.
This will help us speed-up the release process for the provided fix or feature.

### 5.3 Commit and push your changes
If updating a platform package (e.g. `device_info_plus_macos`), please remember to update version and changelog of the main package (e.g. `device_info_plus`).

More info about versioning can be found on [semver.org](https://semver.org/).

### 5.4 Commit and push your changes

Assuming all is successful, commit and push your code:

1. `git commit -a -m "<your informative commit message>"`
2. `git push origin <name_of_your_branch>`

### 5.4 Create a pull request
### 5.5 Create a pull request

To send us a pull request:

Expand All @@ -211,7 +217,7 @@ guide. For example, for a fix to the `sensor_plus` plugin:
Please also enable **“Allow edits by maintainers”**, this will help to speed-up the review
process as well.

### 5.5 Now be patient :)
### 5.6 Now be patient :)

Plugins tests are run automatically on contributions using GitHub Actions. Depending on
your code contributions, various tests will be run against your updated code automatically.
Expand Down