From b2851fdae0687015c2fb1ca95f2d8b3205df1a17 Mon Sep 17 00:00:00 2001 From: team-nimblehq Date: Thu, 3 Aug 2023 02:01:29 +0000 Subject: [PATCH] [Chore] Generate & update sample project --- sample/.github/ISSUE_TEMPLATE/bug_template.md | 8 ++++---- .../.github/ISSUE_TEMPLATE/chore_template.md | 6 +++--- .../ISSUE_TEMPLATE/feature_template.md | 4 ++-- sample/.github/PULL_REQUEST_TEMPLATE.md | 9 ++++----- sample/.github/wiki/.keep | 0 sample/.github/workflows/publish_wiki.yml | 19 +++++++++++++++++++ 6 files changed, 32 insertions(+), 14 deletions(-) create mode 100644 sample/.github/wiki/.keep create mode 100644 sample/.github/workflows/publish_wiki.yml diff --git a/sample/.github/ISSUE_TEMPLATE/bug_template.md b/sample/.github/ISSUE_TEMPLATE/bug_template.md index 5eb84c37..18943b88 100644 --- a/sample/.github/ISSUE_TEMPLATE/bug_template.md +++ b/sample/.github/ISSUE_TEMPLATE/bug_template.md @@ -7,12 +7,12 @@ labels: "type : bug" ## Issue -Describe the issue you are facing. Show us the implementation: screenshots, gif, etc. - +Describe the issue you are facing. Show us the implementation: screenshots, GIFs, etc. + ## Expected -Describe what should be the correct behaviour. - +Describe what should be the correct behavior. + ## Steps to reproduce 1. diff --git a/sample/.github/ISSUE_TEMPLATE/chore_template.md b/sample/.github/ISSUE_TEMPLATE/chore_template.md index bb36ec26..31da9ba4 100644 --- a/sample/.github/ISSUE_TEMPLATE/chore_template.md +++ b/sample/.github/ISSUE_TEMPLATE/chore_template.md @@ -1,14 +1,14 @@ --- name: "Chore" -about: "Open a Chore for minor update." +about: "Open a chore issue for a minor update." title: "Update " labels: "type : chore" --- ## Why -Describe the update details and why it's needed. - +Describe the update in detail and why it is needed. + ## Who Benefits? Describe who will be the beneficiaries e.g. everyone, specific chapters, clients... diff --git a/sample/.github/ISSUE_TEMPLATE/feature_template.md b/sample/.github/ISSUE_TEMPLATE/feature_template.md index 5a26eb96..3b009dfa 100644 --- a/sample/.github/ISSUE_TEMPLATE/feature_template.md +++ b/sample/.github/ISSUE_TEMPLATE/feature_template.md @@ -7,8 +7,8 @@ labels: "type : feature" ## Why -Describe the big picture of the feature and why it's needed. - +Describe the big picture of the feature and why it is needed. + ## Who Benefits? Describe who will be the beneficiaries e.g. everyone, specific chapters, clients... diff --git a/sample/.github/PULL_REQUEST_TEMPLATE.md b/sample/.github/PULL_REQUEST_TEMPLATE.md index 7ac2c256..df3ff384 100644 --- a/sample/.github/PULL_REQUEST_TEMPLATE.md +++ b/sample/.github/PULL_REQUEST_TEMPLATE.md @@ -1,16 +1,15 @@ -https://github.com/nimblehq/sample/issues/?? +- Close # ## What happened 👀 -Describe the big picture of your changes here to communicate to the team why we should accept this pull request. +Provide a description of the **changes** this pull request brings to the codebase. Additionally, when the pull request is still being worked on, a checklist of the planned changes is welcome to track progress. ## Insight 📝 -Describe in details how to test the changes, which solution you tried but did not go with, referenced documentation is -welcome as well. +Describe in detail why this solution is the most appropriate, which solution you tried but did not go with, and how to test the changes. References to relevant documentation are welcome as well. ## Proof Of Work 📹 -Show us the implementation: screenshots, gif, etc. +Show us the implementation: screenshots, GIFs, etc. diff --git a/sample/.github/wiki/.keep b/sample/.github/wiki/.keep new file mode 100644 index 00000000..e69de29b diff --git a/sample/.github/workflows/publish_wiki.yml b/sample/.github/workflows/publish_wiki.yml new file mode 100644 index 00000000..6016ebc8 --- /dev/null +++ b/sample/.github/workflows/publish_wiki.yml @@ -0,0 +1,19 @@ +# For setup instruction, refer to https://github.com/nimblehq/github-actions-workflows/blob/main/.github/workflows/publish_wiki.yml +name: Publish Wiki + +on: + push: + paths: + - .github/wiki/** + branches: + - develop + +jobs: + publish: + name: Publish Wiki + uses: nimblehq/github-actions-workflows/.github/workflows/publish_wiki.yml@0.1.0 + with: + USER_NAME: github-wiki-workflow + USER_EMAIL: ${{ secrets.GH_EMAIL }} + secrets: + USER_TOKEN: ${{ secrets.GH_TOKEN }}