Skip to content

Commit feeaa3b

Browse files
authored
Add issue and pull request templates (#258)
1 parent 002b1e4 commit feeaa3b

File tree

4 files changed

+50
-28
lines changed

4 files changed

+50
-28
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+22-28
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,38 @@
11
---
22
name: Bug report
3-
about: Create a report to help us improve
3+
about: Create a bug report
44
title: ''
5-
labels: bug
5+
labels: bug, needs triage
66
assignees: ''
77

88
---
99

10-
**Describe the bug**
11-
A clear and concise description of what the bug is.
10+
<!--- Please direct any generic questions related to actions to our support community forum at https://github.community/c/code-to-cloud/github-actions/41 --->
11+
<!--- Before opening up a new bug report, please make sure to check for similar existing issues -->
1212

13-
**Which version of the action are you using?**
13+
**Description:**
14+
A clear and concise description of what the bug is.
1415

15-
- [ ] `v1`
16-
- [ ] `v2`
17-
- [ ] Some other tag (such as `v2.0.1` or `master`)
16+
**Action version:**
17+
Specify the action version
1818

19-
**Environment**
20-
- [ ] self-hosted
21-
- [ ] Linux
19+
**Platform:**
20+
- [ ] Ubuntu
21+
- [ ] macOS
2222
- [ ] Windows
23-
- [ ] Mac
24-
25-
If applicable, please specify if you're using a container
2623

27-
**Python Versions**
28-
Please list all of the effected versions of Python (`3.8.2`, etc.)
24+
**Runner type:**
25+
- [ ] Hosted
26+
- [ ] Self-hosted
2927

30-
**To Reproduce**
31-
Steps to reproduce the behavior:
32-
1. Go to '...'
33-
2. Click on '....'
34-
3. Scroll down to '....'
35-
4. See error
28+
**Tools version:**
29+
<!--- Please list all of the affected Python versions (`3.8.2`, etc.)-->
3630

37-
**Run/Repo Url**
38-
If applicable, and if your repo/run is public, please include a URL so it is easier for us to investigate.
31+
**Repro steps:**
32+
A description with steps to reproduce the issue. If your have a public example or repo to share, please provide the link.
3933

40-
**Screenshots**
41-
If applicable, add screenshots to help explain your problem.
34+
**Expected behavior:**
35+
A description of what you expected to happen.
4236

43-
**Additional context**
44-
Add any other context about the problem here.
37+
**Actual behavior:**
38+
A description of what is actually happening.

.github/ISSUE_TEMPLATE/config.yml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false
+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: feature request, needs triage
6+
assignees: ''
7+
---
8+
<!--- Please direct any generic questions related to actions to our support community forum at https://github.community/c/code-to-cloud/github-actions/41 --->
9+
<!--- Before opening up a new feature request, please make sure to check for similar existing issues and pull requests -->
10+
11+
**Description:**
12+
Describe your proposal.
13+
14+
**Justification:**
15+
Justification or a use case for your proposal.
16+
17+
**Are you willing to submit a PR?**
18+
<!--- We accept contributions! -->

.github/pull_request_template.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
**Description:**
2+
Describe your changes.
3+
4+
**Related issue:**
5+
Add link to the related issue.
6+
7+
**Check list:**
8+
- [ ] Mark if documentation changes are required.
9+
- [ ] Mark if tests were added or updated to cover the changes.

0 commit comments

Comments
 (0)