doc: update github templates (#314)

wasabeef · web-flow · commit 27873eacdbe7 · 2022-10-04T15:36:26.000+09:00
* doc: update github templates

* doc: add pubspec section
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,65 @@
+name: Bug Report
+description: File a bug report
+title: "[BUG]: "
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: checkboxes
+    attributes:
+      label: Is there an existing issue for this?
+      description: Please search to see if an issue already exists for the bug you encountered.
+      options:
+        label: I have searched the existing issues
+        required: true
+  - type: input
+    id: version
+    attributes:
+      label: Version
+      description: What version of our software are you running? ($ fluttergen -v)
+      placeholder: ex. 5.0.0
+    validations:
+      required: false
+  - type: dropdown
+    id: command-type
+    attributes:
+      label: Command type
+      description: What version of our software are you running?
+      options:
+        - build_runner (Default)
+        - Dart command
+        - Homebrew
+    validations:
+      required: true
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: Also tell us, what did you expect to happen?
+      placeholder: Tell us what you see!
+      value: "A bug happened!"
+    validations:
+      required: true
+  - type: textarea
+    id: pubspec
+    attributes:
+      label: Relevant a pubspec.yaml.
+      description: Please copy and pates your pubspec.yaml.
+      placeholder: ex. $ cat pubspec.yaml | pbcopy
+      render: yaml
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output, if any.
+      render: shell
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,46 @@
+name: Feature request
+description: File a feature request
+title: "[FR]: "
+labels: ["enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this feature request!
+  - type: checkboxes
+    attributes:
+      label: Is there an existing issue for this?
+      description: Please search to see if an issue already exists for this feature request.
+      options:
+        label: I have searched the existing issues
+        required: true
+  - type: textarea
+    id: describe-problem
+    attributes:
+      label: Describe the problem
+      description: Is your feature request related to a problem? Please describe.
+      placeholder: I'm always frustrated when...
+    validations:
+      required: true
+  - type: textarea
+    id: solution
+    attributes:
+      label: Describe the solution
+      description: Please describe the solution you'd like. A clear and concise description of what you want to happen.
+    validations:
+      required: true
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional context
+      description: Add any other context or screenshots about the feature request here.
+    validations:
+      required: false
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
diff --git a/.github/PULL_REQUEST_TEMPLATE/PULL_REqUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE/PULL_REqUEST_TEMPLATE.md
@@ -0,0 +1,12 @@
+---
+name: Pull request
+about: Create a pull request
+---
+Thank you for opening a Pull Request!
+Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
+- [ ] Make sure to open a GitHub issue as a bug/feature request before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
+  - [ ] Ensure the tests (`melos unit:test-script`)
+  - [ ] Ensure the analyzer and formatter pass (`melos run format` to automatically apply formatting)
+- [ ] Appropriate docs were updated (if necessary)
+
+Fixes #<issue_number_goes_here> 🎯
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -6,8 +6,22 @@ _See also: [Contributor Covenant Code of Conduct](https://github.com/FlutterGen/
 
  * Linux, Mac OS X, or Windows.
  * Flutter and Dart (Stable channel)
+   * [Melos](https://melos.invertase.dev/)
  * Git
 
+## [Melos](https://melos.invertase.dev/getting-started) Installation
+Melos can be installed as a global package via pub.dev:
+```sh
+$ dart pub global activate melos
+```
+
+Once installed & setup, Melos needs to be bootstrapped. Bootstrapping has 2 primary roles:
+- Installing all package dependencies (internally using pub get).
+- Locally linking any packages together.
+```sh
+$ melos bootstrap
+```
+
 ## Running the FlutterGen
 
 #### Use as Dart command
@@ -16,24 +30,28 @@ To run `pub get` to make sure its dependencies have been downloaded, and use `da
 $ dart packages/command/bin/flutter_gen_command.dart --config example/pubspec.yaml
 ```
 
+Or melos
+```sh
+$ melos run example:command
+```
+
 #### Use as part of build_runner
 ```sh
 $ cd example
 $ flutter packages pub run build_runner build
 ```
 
-#### Use Intellij
-
-![Run on IDE](./art/run_on_ide.jpg)
-
+Or melos
+```sh
+$ melos run example:build_runner
+```
 
 ## Running the tests
 
 To run the unit tests:
 
 ```
-$ cd packages/core
-$ pub run test 
+$ melos run unit:test
 ```
 
 ## Contributing code
diff --git a/art/run_on_ide.jpg b/art/run_on_ide.jpg
diff --git a/melos.yaml b/melos.yaml
@@ -12,7 +12,7 @@ ide:
 command:
   bootstrap:
     # NOTE: https://github.com/invertase/melos/issues/117#issuecomment-1125224468
-    # A workaround is to run melos clean before melos publish, 
+    # A workaround is to run melos clean before melos publish,
     # which removes pubspec_overrides.yamls if they were generated by Melos.
     usePubspecOverrides: true
 
@@ -29,7 +29,7 @@ scripts:
     run: |
       melos exec -- dart pub run build_runner build --delete-conflicting-outputs
     select-package:
-      ignore: 
+      ignore:
         - example
         - example_resources
       depends-on: 'build_runner'
