Skip to content

Commit 5114281

Browse files
docs: Improve contributing guidelines
1 parent b6c54f8 commit 5114281

File tree

2 files changed

+28
-14
lines changed

2 files changed

+28
-14
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,21 @@
11
## Connection with issue(s)
22

3-
Resolve issue #???
4-
5-
<!-- Required: this reference (one or many) will be closed upon merge. Ideally it has the acceptance criteria and designs for features or fixes related to the work in this Pull Request -->
6-
7-
Connected to #???
3+
<!-- If this pull request close some issue, use this reference to close it automatically -->
4+
Close #???
85

96
<!-- Optional: other issues or pull requests related to this, but merging should not close it -->
7+
Connected to #???
108

11-
## Testing and Review Notes
12-
13-
<!-- Required: steps to take to confirm this works as expected or other guidance for code, UX, and any other reviewers -->
9+
## Solution description
1410

1511
## Screenshots or Videos
1612

1713
<!-- Optional: to clearly demonstrate the feature or fix to help with testing and reviews -->
1814

1915
## To Do
2016

21-
<!-- Add “WIP” to the PR title if pushing up but not complete nor ready for review -->
22-
- [ ] double check the original issue to confirm it is fully satisfied
23-
- [ ] add testing notes and screenshots in PR description to help guide reviewers
24-
- [ ] request the "UX" team perform a design review (if/when applicable)
17+
- [ ] Read [contributing guide](https://github.com/danvick/flutter_form_builder/blob/master/CONTRIBUTING.md)
18+
- [ ] Check the original issue to confirm it is fully satisfied
19+
- [ ] Add solution description to help guide reviewers
20+
- [ ] Add unit test to verify new or fixed behaviour
21+
- [ ] If apply, add documentation to code properties and package readme

CONTRIBUTING.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,19 +32,36 @@ You don't need to code to help us. If you have a suggestion of a feature, see a
3232
* Change into the example directory: `cd example`
3333
* Run the App: `flutter run`
3434

35-
### Make a pull request
35+
## Implement code
36+
37+
### Enhancement (new feature or request)
38+
39+
- Implement code
40+
- Implement unit tests
41+
- Add example
42+
- Test example in all package compatible platforms
43+
- Are a new component, validator or behaviour; add to readme package
44+
45+
### Bug
46+
47+
- Fix bug
48+
- Update and/or add unit tests to verify fixed behaviour
49+
- Verify if bug is fixed all package compatible platforms
50+
51+
## Make a pull request
3652

3753
We really appreciate contributions via GitHub pull requests. To contribute take the following steps:
3854

3955
* Make sure you are up to date with the latest code on the master:
4056
* `git fetch upstream`
4157
* `git checkout upstream/master -b <name_of_your_branch>`
4258
* Apply your changes
43-
* Verify your changes and fix potential warnings/ errors:
59+
* Verify your local changes and fix potential warnings/errors:
4460
* Check formatting: `flutter format .`
4561
* Run static analyses: `flutter analyze`
4662
* Run tests: `flutter test`
4763
* Commit your changes: `git commit -am "<your informative commit message>"`
4864
* Push changes to your fork: `git push origin <name_of_your_branch>`
65+
* Open a pull request and fill template
4966

5067
Please make sure you solved all warnings and errors reported by the static code analyses and that you fill in the full pull request template. Failing to do so will result in us asking you to fix it.

0 commit comments

Comments
 (0)