Skip to content

Commit

Permalink
Merge pull request #383 from MeshJS/gh-templates
Browse files Browse the repository at this point in the history
update templates
  • Loading branch information
jinglescode authored Nov 14, 2024
2 parents da8dc81 + f12e15f commit 12273c1
Show file tree
Hide file tree
Showing 4 changed files with 148 additions and 68 deletions.
96 changes: 64 additions & 32 deletions .github/ISSUE_TEMPLATE/-bug.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,64 @@
---
name: "[BUG]: Short description of the problem"
about: Create a report to help us improve
title: ""
labels: ""
assignees: ""
---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Station (please complete the following information):**

- OS: [e.g. Windows, Ubuntu]
- Version [e.g. 10, 11, 22.02]

**Additional context**
Add any other context about the problem here.
name: Bug Report
description: Create a bug report
#title: ""
labels: ["bug"]
#assignees:
# -
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report.
Please check the existing issues before raising a bug.
- type: textarea
attributes:
label: Summary
description: A clear and specific description of what the bug is.
validations:
required: true
- type: textarea
attributes:
label: Steps to reproduce the bug
placeholder: |
1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
validations:
required: false
- type: textarea
attributes:
label: Actual Result
description: What is the reproducible outcome?
placeholder: provide your TX JSON if its related to transactions
validations:
required: true
- type: textarea
attributes:
label: Expected Result
description: A clear and concise description of what you expected to happen.
placeholder: No errors observed.
validations:
required: true
- type: input
attributes:
label: SDK version
description: Provide release or Git revision are you using here
placeholder: "0.2.0"
validations:
required: true
- type: checkboxes
attributes:
label: Environment type
description: You may select more than one.
options:
- label: Node.js
- label: Browser
- label: Browser Extension
- label: Other
- type: textarea
attributes:
label: Environment details
description: Provide details and versions of your environemnt
placeholder: |
Browser: Version 1.36.111 Chromium: 99.0.4844.51
Node.js: v14.15.0
54 changes: 38 additions & 16 deletions .github/ISSUE_TEMPLATE/-docs.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,38 @@
---
name: "[DOCS] Short description of the documentation issue"
about: Suggest documentation improvements
title: ""
labels: ""
assignees: ""
---

**Describe the issue with the documentation**
A clear and concise description of what the issue is.

**Suggest a solution**
Describe how the documentation can be improved or corrected.

**Additional context**
Add any other context, references, or screenshots that might help clarify the issue.
name: Documentation improvements
description: Suggest documentation improvements
#title: ""
labels: ["enhancement"]
#assignees:
# -
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this feature request.
Please check the existing issues before submitting.
- type: textarea
id: description
attributes:
label: Describe the issue with the documentation
description: A clear and concise description of what the issue is.
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Suggest a solution
description: Describe how the documentation can be improved or corrected.
validations:
required: false
- type: textarea
id: alternatives
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
validations:
required: false
- type: checkboxes
attributes:
label: Would you be willing to implement it?
options:
- label: "Yes, I will implement it."
64 changes: 45 additions & 19 deletions .github/ISSUE_TEMPLATE/-feature.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,45 @@
---
name: "[FEATURE] Short description of the feature"
about: Suggest an idea for this project
title: ""
labels: ""
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.
name: Feature Request
description: Submit a feature request
#title: ""
labels: ["enhancement"]
#assignees:
# -
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this feature request.
Please check the existing issues before submitting.
- type: textarea
id: description
attributes:
label: Describe the feature you'd like
description: A clear and detailed description of what you are suggesting.
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Is your feature request related to a problem? Please describe.
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
validations:
required: false
- type: textarea
id: alternatives
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen.
validations:
required: false
- type: textarea
id: alternatives
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
validations:
required: false
- type: checkboxes
attributes:
label: Would you be willing to implement it?
options:
- label: "Yes, I will implement it."
2 changes: 1 addition & 1 deletion packages/mesh-core-cst/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
"@harmoniclabs/uplc": "1.2.4",
"@meshsdk/common": "1.7.14",
"@stricahq/bip32ed25519": "^1.1.0",
"@stricahq/cbors": "^1.0.0",
"@stricahq/cbors": "^1.0.3",
"pbkdf2": "^3.1.2"
},
"prettier": "@meshsdk/configs/prettier",
Expand Down

0 comments on commit 12273c1

Please sign in to comment.