Skip to content

Commit 7941b93

Browse files
committed
Add issue and PR templates
1 parent ec08243 commit 7941b93

File tree

2 files changed

+86
-0
lines changed

2 files changed

+86
-0
lines changed

.github/issue_template.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Prerequisites
2+
3+
Please answer the following questions for yourself before submitting an issue. **YOU MAY DELETE THE PREREQUISITES SECTION.**
4+
5+
- [ ] I am running the latest version
6+
- [ ] I checked the documentation and found no answer
7+
- [ ] I checked to make sure that this issue has not already been filed
8+
- [ ] I'm reporting the issue to the correct repository (for multi-repository projects)
9+
10+
<!--
11+
12+
You can file an issue to report a bug, request a feature, or ask a question.
13+
14+
-->
15+
16+
## Expected Behavior
17+
18+
Please describe the behavior you are expecting
19+
20+
## Current Behavior
21+
22+
What is the current behavior?
23+
24+
## Failure Information (for bugs)
25+
26+
Please help provide information about the failure if this is a bug. If it is not a bug, please remove the rest of this template.
27+
28+
## Steps to Reproduce
29+
30+
Please provide detailed steps for reproducing the issue.
31+
32+
<!--
33+
1. step 1: do this
34+
2. step 2: do that
35+
3. you get it...
36+
-->
37+
38+
## Context
39+
40+
Please provide any relevant information about your setup. This is important in case the issue is not reproducible except for under certain conditions.
41+
42+
- Operating System and architecture:
43+
- Go Toolchain version:
44+
- SDK version:
45+
- GatewayD version:
46+
- Plugins' versions:
47+
- Other relevant information: (e.g. Are you using a custom GatewayD config file? Are you using a custom config file for plugins? etc.)
48+
49+
## Failure Logs
50+
51+
Please include any relevant log snippets or files here. **REDACT SENSITIVE INFORMATION BEFORE POSTING**
52+
53+
<!--
54+
If it is too large, please upload the file to a gist and paste the gist link here.
55+
56+
You can also use the GitHub details view to create a collapsed section that users can open to read more:
57+
58+
<details>
59+
<summary>Failure Logs</summary>
60+
<p>Failure Logs</p>
61+
</details>
62+
63+
-->

.github/pull_request_template.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Ticket(s)
2+
3+
## Description
4+
5+
## Related PRs
6+
7+
## Development Checklist
8+
9+
- [ ] I have added a descriptive title to this PR.
10+
- [ ] I have squashed related commits together.
11+
- [ ] I have rebased my branch on top of the latest main branch.
12+
- [ ] I have performed a self-review of my own code.
13+
- [ ] I have commented on my code, particularly in hard-to-understand areas.
14+
- [ ] I have added docstring(s) and type annotations to my code.
15+
- [ ] I have made corresponding changes to the documentation (docs).
16+
- [ ] I have added tests for my changes.
17+
18+
## Legal Checklist
19+
20+
- [ ] I have read the [CONTRIBUTING](https://github.com/gatewayd-io/gatewayd/blob/main/CONTRIBUTING.md) document.
21+
- [ ] I have read and understood the [Code of Conduct](https://github.com/gatewayd-io/gatewayd/blob/main/CODE_OF_CONDUCT.md).
22+
- [ ] I have read and agreed to the [Apache CLA](https://www.apache.org/licenses/contributor-agreements.html) (required).
23+
- [ ] I have read and agreed to the [LICENSE](https://github.com/gatewayd-io/gatewayd/blob/main/LICENSE) (required).

0 commit comments

Comments
 (0)