Skip to content

Commit

Permalink
feat: update GitHub Templates
Browse files Browse the repository at this point in the history
  • Loading branch information
northes committed Apr 22, 2024
1 parent bd6880b commit 47d5c98
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 32 deletions.
34 changes: 14 additions & 20 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,37 +2,31 @@
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
labels: bug
assignees: ''

---

Your issue may already be reported!
Please search on the [issue tracker](https://github.com/northes/go-moonshot/issues) before creating one.

**Describe the bug**
A clear and concise description of what the bug is.
A clear and concise description of what the bug is. If it's an API-related bug, please provide relevant endpoint(s).

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
Steps to reproduce the behavior, including any relevant code snippets.

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

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

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]
**Screenshots/Logs**
If applicable, add screenshots to help explain your problem. For non-graphical issues, please provide any relevant logs or stack traces.

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]
**Environment (please complete the following information):**
- go-moonshot version: [e.g. v0.3.0]
- Go version: [e.g. 1.18]
- Moonshot API version: [e.g. v1]
- OS: [e.g. Ubuntu 20.04]

**Additional context**
Add any other context about the problem here.
Add any other context about the problem here.
10 changes: 0 additions & 10 deletions .github/ISSUE_TEMPLATE/custom.md

This file was deleted.

7 changes: 5 additions & 2 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,14 @@
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
labels: enhancement
assignees: ''

---

Your issue may already be reported!
Please search on the [issue tracker](https://github.com/northes/go-moonshot/issues) before creating one.

**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 [...]

Expand All @@ -17,4 +20,4 @@ A clear and concise description of what you want to happen.
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.
Add any other context or screenshots about the feature request here.
23 changes: 23 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
A similar PR may already be submitted!
Please search among the [Pull request](https://github.com/northes/go-moonshot/pulls) before creating one.

If your changes introduce breaking changes, please prefix the title of your pull request with "[BREAKING_CHANGES]". This allows for clear identification of such changes in the 'What's Changed' section on the release page, making it developer-friendly.

Thanks for submitting a pull request! Please provide enough information so that others can review your pull request.

**Describe the change**
Please provide a clear and concise description of the changes you're proposing. Explain what problem it solves or what feature it adds.

**Provide Moonshot documentation link**
Provide a relevant API doc from https://platform.moonshot.cn/docs

**Describe your solution**
Describe how your changes address the problem or how they add the feature. This should include a brief description of your approach and any new libraries or dependencies you're using.

**Tests**
Briefly describe how you have tested these changes. If possible — please add integration tests.

**Additional context**
Add any other context or screenshots or logs about your pull request here. If the pull request relates to an open issue, please link to it.

Issue: #XXXX

0 comments on commit 47d5c98

Please sign in to comment.