Merge pull request #1066 from danvick/improve-contributing-pr

Improve contributing guidelines

Author: deandreamatias

.github/ISSUE_TEMPLATE/bug_report.md

@@ -7,10 +7,34 @@ labels: bug
 
 ## Environment
 
-**Package name:**  <!-- flutter_form_builder, form_builder_extra_field, form_builder_phone_field or form_builder_validators -->
-**Package version:**  <!-- Add branch if necessary -->
-**Platform:** <!-- iOS, Android, Web, etc -->
-**Device information:**  <!-- Manufacturer and model -->
+**Package name and version:**  <!-- flutter_form_builder, form_builder_extra_field, form_builder_phone_field or form_builder_validators with version-->
+
+<details>
+  <summary>Flutter doctor</summary>
+
+<!-- Paste the output of running `flutter doctor -v` below inside ``` and ``` -->
+```
+```
+
+</details>
+
+<details>
+  <summary>Code sample</summary>
+
+<!--
+      Please create a minimal reproducible sample that shows the problem
+      and attach it below between the lines with the backticks.
+
+      You can use a example code or Flutter sample app
+
+      Without this we will unlikely be able to progress on the issue, and because of that
+      we regretfully will have to close it.
+-->
+
+```dart
+```
+
+</details>
 
 ## Description
 

.github/ISSUE_TEMPLATE/feature_request.md

@@ -7,10 +7,7 @@ labels: enhancement
 
 ## Environment
 
-**Package name:**  <!-- flutter_form_builder, form_builder_extra_field, form_builder_phone_field or form_builder_validators -->
-**Package version:**  <!-- Add branch if necessary -->
-**Platform:** <!-- iOS, Android, Web, etc -->
-**Device information:**  <!-- Manufacturer and model -->
+**Package name and version:**  <!-- flutter_form_builder, form_builder_extra_field, form_builder_phone_field or form_builder_validators with version-->
 
 ## Description
 

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,24 +1,21 @@
 ## Connection with issue(s)
 
-Resolve issue #???
-
-<!-- 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 -->
-
-Connected to #???
+<!-- If this pull request close some issue, use this reference to close it automatically -->
+Close #???
 
 <!-- Optional: other issues or pull requests related to this, but merging should not close it -->
+Connected to #???
 
-## Testing and Review Notes
-
-<!-- Required: steps to take to confirm this works as expected or other guidance for code, UX, and any other reviewers -->
+## Solution description
 
 ## Screenshots or Videos
 
 <!-- Optional: to clearly demonstrate the feature or fix to help with testing and reviews -->
 
 ## To Do
 
-<!-- Add “WIP” to the PR title if pushing up but not complete nor ready for review -->
-- [ ] double check the original issue to confirm it is fully satisfied
-- [ ] add testing notes and screenshots in PR description to help guide reviewers
-- [ ] request the "UX" team perform a design review (if/when applicable)
+- [ ] Read [contributing guide](https://github.com/danvick/flutter_form_builder/blob/master/CONTRIBUTING.md)
+- [ ] Check the original issue to confirm it is fully satisfied
+- [ ] Add solution description to help guide reviewers
+- [ ] Add unit test to verify new or fixed behaviour
+- [ ] If apply, add documentation to code properties and package readme

.github/workflows/form_builder.yaml

@@ -0,0 +1,21 @@
+name: Form Builder Repository
+
+on:
+  push:
+    branches: [master]
+
+  pull_request:
+    branches: [master]
+
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Check broken links
+        uses: JustinBeckwith/linkinator-action@v1
+        with:
+          paths: "**/*.md"

CONTRIBUTING.md

@@ -4,7 +4,7 @@ Thank you for considering and taking the time to contribute to this project!
 
 When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with collaborators of this repository before making a change.
 
-Please note we have a [code of conduct](https://github.com/danvick/flutter_form_builder/CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
+Please note we have a [code of conduct](https://github.com/danvick/flutter_form_builder/blob/master/CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
 
 ## How to Contribute
 
@@ -32,19 +32,36 @@ You don't need to code to help us. If you have a suggestion of a feature, see a
  * Change into the example directory: `cd example`
  * Run the App: `flutter run`
 
-### Make a pull request
+## Implement code
+
+### Enhancement (new feature or request)
+
+- Implement code
+- Implement unit tests
+- Add example
+- Test example in all package compatible platforms
+- Are a new component, validator or behaviour; add to readme package
+
+### Bug
+
+- Fix bug
+- Update and/or add unit tests to verify fixed behaviour
+- Verify if bug is fixed all package compatible platforms
+
+## Make a pull request
 
 We really appreciate contributions via GitHub pull requests. To contribute take the following steps:
 
  * Make sure you are up to date with the latest code on the master: 
    * `git fetch upstream`
    * `git checkout upstream/master -b <name_of_your_branch>`
  * Apply your changes
- * Verify your changes and fix potential warnings/ errors:
+ * Verify your local changes and fix potential warnings/errors:
    * Check formatting: `flutter format .`
    * Run static analyses: `flutter analyze`
    * Run tests: `flutter test`
  * Commit your changes: `git commit -am "<your informative commit message>"`
  * Push changes to your fork: `git push origin <name_of_your_branch>`
+ * Open a pull request and fill template
 
  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.

packages/flutter_form_builder/CHANGELOG.md

@@ -596,15 +596,15 @@
 
 ## [3.2.1] - 22-Jun-2019
 * Add missing attributes for `FormBuilderSlider` to customize `Slider` Widget including `activeColor`, `inactiveColor`, `onChangeStart`, `onChangeEnd`, `label` and `semanticFormatterCallback`. Closes [#80](https://github.com/danvick/flutter_form_builder/issues/80).
-* Add support for `underline` to `FormBuilderDropdown`. Credit [Jordan Nelson](https://github.com/jrnelson333).
+* Add support for `underline` to `FormBuilderDropdown`. Credit Jordan Nelson (github/jrnelson333).
 * Minor fixes to README
 
 ## [3.2.0] - 07-Jun-2019
 * Bumped up `flutter_typeahead` from v1.5.0 to 1.6.1
 * Bumped up `datetime_picker_formfield` from v0.1.8 to 0.2.0
 
 ## [3.1.3] - 06-Jun-2019
-* Made `flutter_typeahead`'s `onSuggestionSelected` available to `FormBuilderTypeAhead` - Closes [#73](https://github.com/danvick/flutter_form_builder/issues/73). Credit to [daWeed](https://github.com/psrcek)
+* Made `flutter_typeahead`'s `onSuggestionSelected` available to `FormBuilderTypeAhead` - Closes [#73](https://github.com/danvick/flutter_form_builder/issues/73). Credit to daWeed (github/psrcek)
 
 ## [3.1.2] - 27-May-2019
 * Attempted fix for `FormBuilderTextField` retaining focus even after moving to other fields causing the UI to jump back to the TextField
@@ -625,7 +625,7 @@
 * Complete rewrite of the package - stateful field widgets
     * `FormBuilderCheckbox` - Single Checkbox field
     * `FormBuilderCheckboxList` - List of Checkboxes for multiple selection
-    * `FormBuilderChipsInput` - Takes a list of Flutter [Chip](https://docs.flutter.io/flutter/material/Chip-class.html) as inputs
+    * `FormBuilderChipsInput` - Takes a list of Flutter [Chip](https://api.flutter.dev/flutter/material/Chip-class.html) as inputs
     * `FormBuilderDateTimePicker` - For Date, Time and DateTime input
     * `FormBuilderDropdown` - Allow selection of one value from a list as a Dropdown
     * `FormBuilderRadio` - Allow selection of one value from a list of Radio Widgets