Skip to content

Commit

Permalink
Add PR and Issue templates (#22)
Browse files Browse the repository at this point in the history
* Add PR and Issue templates

* Add MIT license
  • Loading branch information
arddluma authored Nov 1, 2023
1 parent 2a6f631 commit ef9815d
Show file tree
Hide file tree
Showing 5 changed files with 128 additions and 0 deletions.
58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -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
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -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.
21 changes: 21 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!--- Provide a general summary of your changes in the Title above -->
## Description
<!--- Describe your changes in details -->
-

## Types of changes
What types of changes does your code introduce?
<!-- _Put an `x` in the boxes that apply_ -->

- [ ] 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)
<!--- Additional comments, don't hesitate :) -->
-
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit ef9815d

Please sign in to comment.