Skip to content

Commit

Permalink
Add issue and PR templates
Browse files Browse the repository at this point in the history
  • Loading branch information
mostafa committed Aug 19, 2023
1 parent cba4d62 commit 5611d71
Show file tree
Hide file tree
Showing 2 changed files with 86 additions and 0 deletions.
63 changes: 63 additions & 0 deletions .github/issue_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Prerequisites

Please answer the following questions for yourself before submitting an issue. **YOU MAY DELETE THE PREREQUISITES SECTION.**

- [ ] I am running the latest version
- [ ] I checked the documentation and found no answer
- [ ] I checked to make sure that this issue has not already been filed
- [ ] I'm reporting the issue to the correct repository (for multi-repository projects)

<!--
You can file an issue to report a bug, request a feature, or ask a question.
-->

## Expected Behavior

Please describe the behavior you are expecting

## Current Behavior

What is the current behavior?

## Failure Information (for bugs)

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.

## Steps to Reproduce

Please provide detailed steps for reproducing the issue.

<!--
1. step 1: do this
2. step 2: do that
3. you get it...
-->

## Context

Please provide any relevant information about your setup. This is important in case the issue is not reproducible except for under certain conditions.

- Operating System and architecture:
- Go Toolchain version:
- SDK version:
- GatewayD version:
- Plugins' versions:
- Other relevant information: (e.g. Are you using a custom GatewayD config file? Are you using a custom config file for plugins? etc.)

## Failure Logs

Please include any relevant log snippets or files here. **REDACT SENSITIVE INFORMATION BEFORE POSTING**

<!--
If it is too large, please upload the file to a gist and paste the gist link here.
You can also use the GitHub details view to create a collapsed section that users can open to read more:
<details>
<summary>Failure Logs</summary>
<p>Failure Logs</p>
</details>
-->
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 @@
# Ticket(s)

## Description

## Related PRs

## Development Checklist

- [ ] I have added a descriptive title to this PR.
- [ ] I have squashed related commits together.
- [ ] I have rebased my branch on top of the latest main branch.
- [ ] I have performed a self-review of my own code.
- [ ] I have commented on my code, particularly in hard-to-understand areas.
- [ ] I have added docstring(s) and type annotations to my code.
- [ ] I have made corresponding changes to the documentation (docs).
- [ ] I have added tests for my changes.

## Legal Checklist

- [ ] I have read the [CONTRIBUTING](https://github.com/gatewayd-io/gatewayd/blob/main/CONTRIBUTING.md) document.
- [ ] I have read and understood the [Code of Conduct](https://github.com/gatewayd-io/gatewayd/blob/main/CODE_OF_CONDUCT.md).
- [ ] I have read and agreed to the [Apache CLA](https://www.apache.org/licenses/contributor-agreements.html) (required).
- [ ] I have read and agreed to the [LICENSE](https://github.com/gatewayd-io/gatewayd/blob/main/LICENSE) (required).

0 comments on commit 5611d71

Please sign in to comment.