Merge pull request #98 from SanjulaGanepola/feature/bug-report

Add issue templates, pr templates, and CONTRIBUTING.md
2024-11-30 20:07:43 -05:00
parent d032fe2d3d c72f59d1b2
commit f6512b5c53
7 changed files with 193 additions and 1 deletions
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,97 @@
+name: 🚨 Bug Report
+description: Report a bug or issue.
+labels:
+  - 'bug'
+body:
+  - type: input
+    id: github-local-actions-version
+    attributes:
+      label: Github Local Actions Version
+      description: |
+        What version of `Github Local Actions` are you using? This can be obtained from the standard `Extensions` view.
+      placeholder: |
+        v#.#.#
+    validations:
+      required: true
+  - type: input
+    id: act-version
+    attributes:
+      label: Act Version
+      description: |
+        What version of `act` are you using? This can be obtained from the `Components` view or by running `act --version`.
+      placeholder: |
+        act version #.#.#
+    validations:
+      required: true
+  - type: input
+    id: github-repository-link
+    attributes:
+      label: GitHub Repository Link
+      description: |
+        If your GitHub repository is public, provide a link to help us troubleshoot the problem.
+      placeholder: |
+        https://github.com/...
+    validations:
+      required: false
+  - type: textarea
+    id: workflow-content
+    attributes:
+      label: Workflow Content
+      description: |
+        Share your **entire** workflow here.
+      placeholder: |
+        name: My workflow
+        on: ['push', 'schedule']
+        jobs:
+          test:
+            runs-on: ubuntu-latest
+          env:
+            KEY: VAL
+        [...]
+      render: yml
+    validations:
+      required: false
+  - type: textarea
+      id: act-command-used
+      attributes:
+        label: Act Command Used
+        description: |
+          Share the entire act command which was used. This can be obtained from the VS Code task used to execute the workflow.
+          If you no longer have the task open, you can select `View Output` from the `History` view and find it on the first line of the log file.
+          ⚠️ Please make sure all sensitive information is removed. ⚠️
+        placeholder: |
+          act -P ubuntu-latest=node:12 -v ...
+        render: sh
+      validations:
+        required: false
+  - type: textarea
+    id: act-command-output
+    attributes:
+      label: Act Command Output
+      description: |
+        Copy and paste any relevant log output from the VS Code task or log file. This will be automatically formatted into code, so no need for backticks.
+        ⚠️ Please make sure all sensitive information is removed. ⚠️
+      placeholder: |
+        Use `act -v` for verbose output
+      render: sh
+    validations:
+      required: false
+  - type: textarea
+    id: bug-description
+    attributes:
+      label: Bug Description
+      description: |
+        Describe the bug you encountered and share all steps to reproduce it.
+    validations:
+      required: true
+  - type: textarea
+    id: act-bug-report
+    attributes:
+      label: Act Bug Report
+      description: |
+        Provide the output of `act --bug-report`
+      placeholder: |
+        act --bug-report
+      render: yml
+    validations:
+      required: false
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,8 @@
+blank_issues_enabled: true
+contact_links:
+  - name: ✍️ Start a Discussion!
+    url: https://github.com/SanjulaGanepola/github-local-actions/discussions
+    about: You can ask for help here.
+  - name: 🙏 Learn How to Contribute!
+    url: https://github.com/SanjulaGanepola/github-local-actions/blob/main/CONTRIBUTING.md
+    about: Check out the contributing guidelines.
--- a/.github/ISSUE_TEMPLATE/documentation_issue.yml
+++ b/.github/ISSUE_TEMPLATE/documentation_issue.yml
@@ -0,0 +1,15 @@
+name: 📖 Documentation Issue
+description: Report an issue or enhancement regarding the documentation.
+labels:
+  - 'documentation'
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description:
+        label: Description
+        description: |
+          Describe the issue or enhancement regarding the documentation.
+    validations:
+      required: true
--- a/.github/ISSUE_TEMPLATE/feature_request.yml
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,33 @@
+name: 💡 Feature Request
+description: Suggest an idea for this project.
+labels:
+  - 'enhancement'
+body:
+  - type: input
+    id: github-local-actions-version
+    attributes:
+      label: Github Local Actions Version
+      description: |
+        What version of `Github Local Actions` are you using? This can be obtained from the standard `Extensions` view.
+      placeholder: |
+        v#.#.#
+    validations:
+      required: true
+  - type: input
+    id: act-version
+    attributes:
+      label: Act Version
+      description: |
+        What version of `act` are you using? This can be obtained from the `Components` view or by running `act --version`.
+      placeholder: |
+        act version #.#.#
+    validations:
+      required: true
+  - type: textarea
+    id: feature-description
+    attributes:
+      label: Feature Description
+      description: |
+        Describe the feature that you would like to see.
+    validations:
+      required: true
--- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
+++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
@@ -0,0 +1,8 @@
+### ✍ Changes
+<!-- Describe the changes made in this pull request -->
+
+### 📋 Checklist
+<!-- Complete the checklist -->
+- [ ] I tested my changes
+- [ ] I updated relevant documentation
+- [ ] I added myself to the [contributors' list](https://github.com/SanjulaGanepola/github-local-actions/blob/main/CONTRIBUTING.md#contributors)
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -0,0 +1,31 @@
+# 🙏 Contributing to Github Local Actions
+
+Thank you for your interest in contributing to **GitHub Local Actions**! Whether you're fixing a bug, adding a new feature, or improving the documentation, your contributions are highly valued and help make this project better for everyone.
+
+No contribution is too small—every bit helps! If you're unsure where to start, check out our [open issues](https://github.com/SanjulaGanepola/github-local-actions/issues) or reach out on our [discussion board](https://github.com/SanjulaGanepola/github-local-actions/discussions) to discuss your ideas.
+
+> 👉 Friendly Reminder: By contributing, you are agreeing to follow our [Code of Conduct](https://github.com/SanjulaGanepola/github-local-actions/blob/main/CODE_OF_CONDUCT.md) guidelines. Let’s keep this a welcoming and fun space for everyone to collaborate!
+
+## Getting Started
+
+1. Install [VS Code](https://code.visualstudio.com/download) and [Node.js](https://nodejs.org/en/download/package-manager).
+2. Create a [fork](https://github.com/SanjulaGanepola/github-local-actions/fork) of this repository.
+3. Clone your fork.
+   ```sh
+   git clone https://github.com/your-username/github-local-actions.git
+   cd github-local-actions
+   ```
+4. Install all dependencies.
+    ```sh
+    npm install
+    ```
+5. Use `Run Extension` from VS Code's `Run and Debug` view.
+
+## Contributors
+
+Thanks so much to everyone [who has contributed](https://github.com/SanjulaGanepola/github-local-actions/graphs/contributors) to making GitHub Local Actions a success!
+
+* [@SanjulaGanepola](https://github.com/SanjulaGanepola)
+* [@ChristopherHX](https://github.com/ChristopherHX)
+
+Want to see your name on this list? Join us and contribute!
--- a/README.md
+++ b/README.md
@@ -63,7 +63,7 @@ Feel free to share any bugs or feature requests in the project's [GitHub Issues]

 ## Contribution

-Contributions are always welcome! Please see our contributing guide for more details.
+Contributions are always welcome! Please see our [contributing guide](https://github.com/SanjulaGanepola/github-local-actions/blob/main/CONTRIBUTING.md) for more details.

 ## Maintainers