Skip to content

Commit

Permalink
Add GitHub issue templates and update release notes generator humor
Browse files Browse the repository at this point in the history
 level
  • Loading branch information
hathbanger committed Nov 13, 2024
1 parent b80b4c9 commit 94f503f
Show file tree
Hide file tree
Showing 6 changed files with 109 additions and 1 deletion.
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: 🐛 Bug Report
about: Report a bug or unexpected behavior in the library
title: "[Bug]: "
labels: bug
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. Use '...'
3. See error

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

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

**Environment (please complete the following information):**
- Library Version: [e.g., 1.2.0]
- Node Version: [e.g., 18.x]
- Wallet Provider: [e.g., UniSat, Xverse]
- Operating System: [e.g., macOS, Windows]

**Additional context**
Add any other context about the problem here.
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_improvement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
name: 📚 Documentation Improvement
about: Suggest changes or improvements to the documentation
title: "[Docs]: "
labels: documentation
assignees: ''
---

**Describe the improvement**
What specific part of the documentation could be improved?

**Suggestion for Improvement**
Provide a description of the improvement or addition you are proposing.

**Additional context**
Is there any other relevant information or context?
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: 🚀 Feature Request
about: Suggest an idea or enhancement for the library
title: "[Feature]: "
labels: enhancement
assignees: ''
---

**Is your feature request related to a problem?**
Please describe the problem you’re trying to solve.

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
Any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/security_vulnerability.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: 🔒 Security Vulnerability
about: Report a security vulnerability in the library
title: "[Security]: "
labels: security
assignees: ''
---

**Describe the vulnerability**
A clear and concise description of the security vulnerability.

**Potential Impact**
Describe the potential impact of this vulnerability if exploited.

**Steps to Reproduce**
Steps to reproduce the behavior, if possible:
1. ...
2. ...

**Environment (please complete the following information):**
- Library Version: [e.g., 1.2.0]
- Node Version: [e.g., 18.x]
- Wallet Provider: [e.g., UniSat, Xverse]

**Additional context**
Add any other context, logs, or details here.
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/support_question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
name: ❓ Support/Question
about: Ask a question or request guidance about using the library
title: "[Support]: "
labels: question
assignees: ''
---

**Question**
Please describe your question or the guidance you need.

**Context**
Provide any relevant code snippets or configuration information to help explain your question.

**Additional context**
Add any other context or screenshots that may help explain your question.
2 changes: 1 addition & 1 deletion scripts/generate_release_notes.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
response = openai.ChatCompletion.create(
model="gpt-4",
messages=[
{"role": "system", "content": "You are a passive aggressive release note generator. Create detailed, sometimes hilarious release notes based on the git diff provided. Always ensure you are informative and helpful. On a humor scale of 1-10, you're a 1. Don't mention anything about the lock file or about anything ot her then the main version changes."},
{"role": "system", "content": "You are a passive aggressive release note generator. Create detailed, sometimes hilarious release notes based on the git diff provided. Always ensure you are informative and helpful. On a humor scale of 1-10, you're a 3, but you don't share it very often.. YOU MUST BE INFORMATIVE, please. remember these are release notes. Don't mention anything about the lock file or about anything ot her then the main version changes."},
{"role": "user", "content": f"Version: {version}\n{diff_content}"}
]
)
Expand Down

0 comments on commit 94f503f

Please sign in to comment.