flutter/flame
1
0
Fork 0
mirror of https://github.com/flame-engine/flame.git synced 2025-11-03 20:36:31 +08:00
Code Issues Packages Projects Releases Wiki Activity

Follow up (#693)

Browse Source 
* Follow up

* Updated PR template

Co-authored-by: Erick <erickzanardoo@gmail.com>
This commit is contained in:
Jochum van der Ploeg
2021-03-09 23:53:29 +01:00
committed by GitHub
parent edc54fdc34
commit e5dc89293c
2 changed files with 6 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
.github/pull_request_template.md vendored
View File

@ -1,4 +1,4 @@
## Description # Description
*Replace this paragraph with a description of what this PR is doing. If you're modifying existing behavior, describe the existing behavior, how this MR is changing it, and what motivated the change. If this is a breaking change, specify explicitly which APIs have been changed* *Replace this paragraph with a description of what this PR is doing. If you're modifying existing behavior, describe the existing behavior, how this MR is changing it, and what motivated the change. If this is a breaking change, specify explicitly which APIs have been changed*
@ -7,17 +7,13 @@
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. 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.
- [ ] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [ ] 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]). - [ ] My PR includes unit or integration tests for *all* changed/updated/fixed behaviors and are passing (See [Contributor Guide]).
- [ ] All existing and new tests are passing. - [ ] I updated/added relevant documentation (doc comments with `///`) and updated/added examples in `doc/examples`.
- [ ] I updated/added relevant documentation (doc comments with `///`). - [ ] I have formatted my code with `./scripts/format.sh` and the Flame analyzer (`./scripts/analyze.sh`) does not report any problems.
- [ ] The Flame analyzer (`./scripts/analyze.sh`) does not report any problems on my PR.
- [ ] I have added examples for new features in `doc/examples`.
- [ ] I have formatted my code with `./scripts/format.sh`.
- [ ] I read and followed the [Flutter Style Guide]. - [ ] I read and followed the [Flutter Style Guide].
- [ ] I have added a description of the change under `[next]` in `CHANGELOG.md`. - [ ] I have added a description of the change under `[next]` in `CHANGELOG.md`.
- [ ] I removed the `Draft` status, by clicking on the `Ready for review` button in this PR.
- [ ] I am willing to follow-up on review comments in a timely manner. - [ ] I am willing to follow-up on review comments in a timely manner.
- [ ] I am happy with the current version of this PR and it is ready to be reviewd
- [ ] I removed the `Draft` status, by clicking on the `Ready for review` button in this PR.
## Breaking Change ## Breaking Change
@ -34,4 +30,3 @@ Does your PR require Flame users to manually update their apps to accommodate yo
[issue database]: https://github.com/flame-engine/flame/issues [issue database]: https://github.com/flame-engine/flame/issues
[Contributor Guide]: https://github.com/flame-engine/flame/blob/master/CONTRIBUTING.md [Contributor Guide]: https://github.com/flame-engine/flame/blob/master/CONTRIBUTING.md
[Flutter Style Guide]: https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo [Flutter Style Guide]: https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo
[pub versioning philosophy]: https://www.dartlang.org/tools/pub/versioning

2
CONTRIBUTING.md
View File

@ -21,7 +21,7 @@ If you're interested in contributing to this project, here are a few ways to do
## Documentation & Miscellaneous ## Documentation & Miscellaneous
* If you think the documentation could be clearer or an example should be added, or you have an alternative implementation of something that may have more advantages, we would love to hear it. * If you think the documentation could be clearer or an example should be added, or you have an alternative implementation of something that may have more advantages, we would love to hear it.
* As always first file a report in a [Github issues](https://github.com/flame-engine/flame/issues/new). * As always first file a report in [Github issues](https://github.com/flame-engine/flame/issues/new).
* Issues that have been identified as a documentation change will be labelled "documentation". * Issues that have been identified as a documentation change will be labelled "documentation".
* Implement the changes to the documentation, please read the [How To](#how-to) and [Development Guidelines](#development-guidelines). * Implement the changes to the documentation, please read the [How To](#how-to) and [Development Guidelines](#development-guidelines).