Skip to content

Commit ad7c4e7

Browse files
committed
chore(issue-templates): add templates for reporting issues
1 parent fa2bbbf commit ad7c4e7

File tree

4 files changed

+154
-0
lines changed

4 files changed

+154
-0
lines changed
Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
name: Bug Report
3+
about: Something isn't working as expected
4+
labels:
5+
- bug
6+
- triage
7+
---
8+
9+
## Bug Report
10+
11+
### Description
12+
<!-- A description of what you were trying to do (error logs should go in the section at the end)-->
13+
14+
15+
16+
### Expected behavior
17+
<!-- A short description of what you expected to happen. -->
18+
19+
20+
21+
### Actual behavior
22+
<!-- A short description of what actually happened. (error log goes in its own section!) -->
23+
24+
25+
26+
### Environment
27+
28+
- **Action version:** <!-- x.x.x -->
29+
30+
### Configuration
31+
32+
<!--
33+
Please provide your job/workflow definition between the code fences (```).
34+
-->
35+
36+
<details>
37+
<summary>GitHub Actions Job Definition</summary>
38+
39+
```yaml
40+
41+
```
42+
43+
</details>
44+
45+
<details>
46+
<summary>Semantic Release Configuration</summary>
47+
48+
```toml
49+
50+
```
51+
52+
</details>
53+
54+
### Execution Log
55+
56+
<!--
57+
Please include the log output from the job in the code fence (```)
58+
with the -vv flag as a root_options argument applied to the GitHub Action.
59+
-->
60+
61+
<details>
62+
<summary><code>semantic-release -vv publish</code></summary>
63+
64+
```log
65+
66+
```
67+
68+
</details>
69+
70+
### Additional context
71+
72+
<!--
73+
Feel free to add any other information that could be useful,
74+
such as a link to your project (if public), links to a failing GitHub Action,
75+
or an example commit.
76+
-->
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Documentation
3+
about: I found an error or gap in the docs
4+
labels:
5+
- docs
6+
- triage
7+
---
8+
9+
## Documentation Error
10+
11+
### Description
12+
<!--
13+
Please provide a description of your documentation improvement or issue.
14+
15+
As necessary please include links to any relevant pages or files.
16+
-->
17+
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new idea
4+
labels:
5+
- feature
6+
- triage
7+
---
8+
9+
## Feature Request
10+
11+
### Description
12+
<!-- A clear and concise description of your idea. -->
13+
14+
15+
16+
### Use cases
17+
<!-- List some reasons this would be useful. -->
18+
19+
20+
21+
### Possible implementation
22+
<!-- Describe any ideas you have for how this could work. -->
23+
24+
25+
26+
### Alternative solutions
27+
<!-- Describe any alternative solutions or features you've considered. -->

.github/ISSUE_TEMPLATE/question.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: Question
3+
about: I have a question about the Python Semantic Release Publish Action
4+
labels:
5+
- question
6+
- triage
7+
---
8+
9+
## Question
10+
<!--
11+
Please include a clear and concise description of what you want to know or your desired outcome
12+
-->
13+
14+
15+
16+
### Configuration
17+
18+
<!--
19+
If you are trying to get your configuration to work, please include your current
20+
semantic-release configuration.
21+
-->
22+
23+
<details>
24+
<summary>Semantic Release Configuration</summary>
25+
26+
```toml
27+
28+
```
29+
30+
</details>
31+
32+
33+
## Additional context
34+
<!-- Please include any logs or additional context that might help us answer your question -->

0 commit comments

Comments
 (0)