From f3b07f326c9d2e1bb4dbd01cf9f98ee650bcd29d Mon Sep 17 00:00:00 2001 From: goncalo-frade-iohk Date: Mon, 4 Sep 2023 13:03:11 +0100 Subject: [PATCH] chore: add issue template and pull request template --- .github/ISSUE_TEMPLATE.md | 5 +++ .github/ISSUE_TEMPLATE/1-bug-report.yaml | 37 +++++++++++++++++++ .github/ISSUE_TEMPLATE/2-feature-request.yaml | 22 +++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/PULL_REQUEST_TEMPLATE.md | 28 ++++++++++++++ CONTRIBUTING.md | 10 ++--- 6 files changed, 98 insertions(+), 5 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/1-bug-report.yaml create mode 100644 .github/ISSUE_TEMPLATE/2-feature-request.yaml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..c989726a --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,5 @@ +To submit a new issue, please, use one of the following templates: + +https://github.com/input-output-hk/atala-prism-building-blocks/issues/new/choose + +Thank you! diff --git a/.github/ISSUE_TEMPLATE/1-bug-report.yaml b/.github/ISSUE_TEMPLATE/1-bug-report.yaml new file mode 100644 index 00000000..27c0e95a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-bug-report.yaml @@ -0,0 +1,37 @@ +name: Bug Report +description: Report a bug in the Atala PRISM Swift SDK + +body: + - type: dropdown + id: is-regression + attributes: + label: Is this a regression? + options: + - 'Yes' + - 'No' + validations: + required: true + + - type: textarea + id: description + attributes: + label: Description + validations: + required: true + + - type: textarea + id: exception-or-error + attributes: + label: Please provide the exception or error you saw + render: true + + - type: textarea + id: environment + attributes: + label: Please provide the environment you discovered this bug in + render: true + + - type: textarea + id: other + attributes: + label: Anything else? diff --git a/.github/ISSUE_TEMPLATE/2-feature-request.yaml b/.github/ISSUE_TEMPLATE/2-feature-request.yaml new file mode 100644 index 00000000..f50289bf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-feature-request.yaml @@ -0,0 +1,22 @@ +name: 'Feature Request' +description: Suggest a new feature for Atala PRISM Swift SDK + +body: + - type: textarea + id: proposed-feature + attributes: + label: Proposed feature + validations: + required: true + + - type: textarea + id: description + attributes: + label: Feature description + validations: + required: true + + - type: textarea + id: other + attributes: + label: Anything else? diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..3ba13e0c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..5932c7db --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,28 @@ +# Overview + + +Fixes ATL-xxxx + +## Checklist + +### My PR contains... +* [ ] No code changes (changes to documentation, CI, metadata, etc.) +* [ ] Bug fixes (non-breaking change which fixes an issue) +* [ ] Improvements (misc. changes to existing features) +* [ ] Features (non-breaking change which adds functionality) + +### My changes... +* [ ] are breaking changes +* [ ] are not breaking changes +* [ ] If yes to above: I have updated the documentation accordingly + +### Documentation +* [ ] My changes do not require a change to the project documentation +* [ ] My changes require a change to the project documentation +* [ ] If yes to above: I have updated the documentation accordingly + +### Tests +* [ ] My changes can not or do not need to be tested +* [ ] My changes can and should be tested by unit and/or integration tests +* [ ] If yes to above: I have added tests to cover my changes +* [ ] If yes to above: I have taken care to cover edge cases in my tests diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2063acc2..eaa49c0c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -51,7 +51,7 @@ The process described here has several goals: Please follow these steps to have your contribution considered by the maintainers: -1. Follow all instructions in [the template](PULL_REQUEST_TEMPLATE.md) +1. Follow all instructions in [the template](https://github.com/input-output-hk/atala-prism-wallet-sdk-swift/blob/main/.github/PULL_REQUEST_TEMPLATE.md) 2. Follow the [styleguides](#styleguides) 3. After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks/) are passing
What if the status checks are failing?If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.
@@ -61,15 +61,15 @@ While the prerequisites above must be satisfied prior to having your pull reques This section guides you through submitting a bug report for Atala PRISM Swift SDK. Following these guidelines helps maintainers and the community understand your report :pencil:, reproduce the behavior :computer: :computer:, and find related reports :mag_right:. -Before creating bug reports, please check [this list](#before-submitting-a-bug-report) as you might find out that you don't need to create one. When you are creating a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report). Fill out [the required template](https://github.com/input-output-hk/atala-prism-swift-sdk/blob/main/.github/ISSUE_TEMPLATE/bug_report.md), the information it asks for helps us resolve issues faster. +Before creating bug reports, please check [this list](#before-submitting-a-bug-report) as you might find out that you don't need to create one. When you are creating a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report). Fill out [the required template](https://github.com/input-output-hk/atala-prism-wallet-sdk-swift/blob/main/.github/ISSUE_TEMPLATE/1-bug-report.yaml), the information it asks for helps us resolve issues faster. > **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one. * **You might be able to find the cause of the problem and fix things yourself by Debugging**. Most importantly, check if you can reproduce the problem in the latest version. -* **Check the [Readme](https://github.com/input-output-hk/atala-prism-swift-sdk/blob/main/README.md) ** if you have problems on the setup and the [discussions](https://github.com/input-output-hk/atala-prism-swift-sdk/discussions)** for a list of common questions and problems. +* **Check the [Readme](https://github.com/input-output-hk/atala-prism-wallet-sdk-swift/blob/main/README.md) ** if you have problems on the setup and the [discussions](https://github.com/input-output-hk/atala-prism-wallet-sdk-swift/discussions)** for a list of common questions and problems. * **Perform a cursory search to see if the problem has already been reported**. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one. -Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). Create an issue on that repository and provide the following information by filling in [the template](https://github.com/input-output-hk/atala-prism-swift-sdk/blob/main/.github/ISSUE_TEMPLATE/bug_report.md). +Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). Create an issue on that repository and provide the following information by filling in [the template](https://github.com/input-output-hk/atala-prism-wallet-sdk-swift/issues/new/choose). Explain the problem and include additional details to help maintainers reproduce the problem: @@ -91,7 +91,7 @@ Provide more context by answering these questions: This section guides you through submitting an enhancement suggestion for the SDK, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion :pencil: and find related suggestions :mag_right:. -Before creating enhancement suggestions, please check [this list](#before-submitting-an-enhancement-suggestion) as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please [include as many details as possible](#how-do-i-submit-a-good-enhancement-suggestion). Fill in [the template](https://github.com/input-output-hk/atala-prism-swift-sdk/blob/main/.github/ISSUE_TEMPLATE/feature_request.md), including the steps that you imagine you would take if the feature you're requesting existed. +Before creating enhancement suggestions, please check [this list](#before-submitting-an-enhancement-suggestion) as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please [include as many details as possible](#how-do-i-submit-a-good-enhancement-suggestion). Fill in [the template](https://github.com/input-output-hk/atala-prism-wallet-sdk-swift/blob/main/.github/ISSUE_TEMPLATE/2-feature-request.yaml), including the steps that you imagine you would take if the feature you're requesting existed. * Most importantly, **check if you're using the lattest version.** * **Perform a cursory search** to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.