From ef9815ded8dbe2a40cb98c185e28a8b8419813a5 Mon Sep 17 00:00:00 2001 From: Ardian <34317628+arddluma@users.noreply.github.com> Date: Wed, 1 Nov 2023 15:11:00 +0100 Subject: [PATCH] Add PR and Issue templates (#22) * Add PR and Issue templates * Add MIT license --- .github/ISSUE_TEMPLATE/bug_report.yml | 58 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 ++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++ .github/pull_request_template.md | 21 ++++++++ LICENSE | 21 ++++++++ 5 files changed, 128 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/pull_request_template.md create mode 100644 LICENSE diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..1be8fcb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,58 @@ +name: 🐛 Bug report +description: Create a bug report to help us improve +title: "[BUG] " +body: + - type: textarea + id: describe + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is and steps to reproduce it. + placeholder: This is what I'm seeing. + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected behavior + description: A clear and concise description of what you expected to happen. + placeholder: This is what should happen. + validations: + required: true + - type: textarea + id: steps + attributes: + label: Steps to reproduce + description: List the steps to reproduce the behavior + placeholder: | + 1. Run command 'npm install && npm run dev' + 2. Check debug and log errors + validations: + required: false + - type: textarea + id: attachments + attributes: + label: Additional context + description: If applicable, add screenshots, links or other context about the issue + placeholder: | + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false + - type: dropdown + attributes: + label: Operating system + description: What type of operating system are you running on? + multiple: false + options: + - Linux + - macOS + - Windows + validations: + required: true + - type: input + id: version + attributes: + label: Arka version or commit hash + description: Which version or commit hash of Skandha are you running? + placeholder: v0.0.1 or 214ee64 + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..b0bdefd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: true +contact_links: + - name: Documentation + url: https://etherspot.fyi/arka/intro + about: For more detailed guide follow our docs + - name: Join our Discord community + url: https://discord.etherspot.io + about: Participate in our thriving community of contributors, users, and supporters. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..01869ff --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: "\U0001F680 Feature request" +about: Suggest an idea/feature for Arka Paymaster +title: "[FEATURE]" +labels: enhancement +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..08e8500 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,21 @@ + +## Description + +- + +## Types of changes +What types of changes does your code introduce? + + +- [ ] Bugfix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] Documentation Update +- [ ] Code style update (formatting, renaming) +- [ ] Refactoring (no functional changes, no api changes) +- [ ] Build related changes +- [ ] Other (please describe): + +## Further comments (optional) + +- diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..796efd8 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 Etherspot + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file