From bcd0431e813103398f11120d79b87bc9136d53b6 Mon Sep 17 00:00:00 2001 From: Sanjula Ganepola Date: Sat, 30 Nov 2024 19:46:28 -0500 Subject: [PATCH 1/4] Add issue templates Signed-off-by: Sanjula Ganepola --- .github/ISSUE_TEMPLATE/bug_report.yml | 97 +++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 ++ .../ISSUE_TEMPLATE/documentation_issue.yml | 15 +++ .github/ISSUE_TEMPLATE/feature_request.yml | 33 +++++++ 4 files changed, 153 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/documentation_issue.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..e9bafb0 --- /dev/null +++ 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 \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..2c7e220 --- /dev/null +++ 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. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/documentation_issue.yml b/.github/ISSUE_TEMPLATE/documentation_issue.yml new file mode 100644 index 0000000..0633caa --- /dev/null +++ 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 \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..686c667 --- /dev/null +++ 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 \ No newline at end of file From 8fdf37dc96bab2e85598c87412c344fd7f5da6db Mon Sep 17 00:00:00 2001 From: Sanjula Ganepola Date: Sat, 30 Nov 2024 19:46:58 -0500 Subject: [PATCH 2/4] Add contributing guide Signed-off-by: Sanjula Ganepola --- CONTRIBUTING.md | 31 +++++++++++++++++++++++++++++++ README.md | 2 +- 2 files changed, 32 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..2d4ebb7 --- /dev/null +++ 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! \ No newline at end of file diff --git a/README.md b/README.md index 88a0733..5454a4e 100644 --- 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 From b709ad2bfb34e024c45a8192c19c20a26c4737e2 Mon Sep 17 00:00:00 2001 From: Sanjula Ganepola Date: Sat, 30 Nov 2024 20:04:54 -0500 Subject: [PATCH 3/4] Add PR template Signed-off-by: Sanjula Ganepola --- .github/PULL_REQUEST_TEMPLATE/pull_request_template.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 0000000..b3e9177 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,8 @@ +### โœ Changes + + +### ๐Ÿ“‹ Checklist + +- [ ] I tested my changes +- [ ] Updated relevant documentation +- [ ] I added myself to the [contributors' list](https://github.com/SanjulaGanepola/github-local-actions/blob/main/CONTRIBUTING.md#contributors) \ No newline at end of file From c72f59d1b290e67e036fb1f5edc37dbdca80f04b Mon Sep 17 00:00:00 2001 From: Sanjula Ganepola Date: Sat, 30 Nov 2024 20:06:16 -0500 Subject: [PATCH 4/4] fix checklist Signed-off-by: Sanjula Ganepola --- .github/PULL_REQUEST_TEMPLATE/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index b3e9177..591f904 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -4,5 +4,5 @@ ### ๐Ÿ“‹ Checklist - [ ] I tested my changes -- [ ] Updated relevant documentation +- [ ] I updated relevant documentation - [ ] I added myself to the [contributors' list](https://github.com/SanjulaGanepola/github-local-actions/blob/main/CONTRIBUTING.md#contributors) \ No newline at end of file