mirror of
https://github.com/pomerium/pomerium.git
synced 2025-08-03 08:50:42 +02:00
docs: add issue templates
This commit is contained in:
parent
661fd89feb
commit
4a52835baa
3 changed files with 77 additions and 0 deletions
41
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
41
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
|
@ -0,0 +1,41 @@
|
|||
---
|
||||
name: Bug report
|
||||
about: Let us know about a bug!
|
||||
---
|
||||
|
||||
<!-- Please reserve GitHub issues for bug reports and feature requests. -->
|
||||
|
||||
**Describe the bug** A clear and concise description of what the bug is.
|
||||
|
||||
**To Reproduce** Steps to reproduce the behavior:
|
||||
|
||||
1. Ran `x`
|
||||
2. Clicked `y`
|
||||
3. Saw error `z`
|
||||
|
||||
**Expected behavior**
|
||||
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
||||
**Environment:**
|
||||
|
||||
- Pomerium version (retrieve with `pomerium --version`):
|
||||
- Server Operating System/Architecture/Cloud:
|
||||
|
||||
Configuration file(s):
|
||||
|
||||
```text
|
||||
# Paste your confis here.
|
||||
# Be sure to scrub any sensitive values
|
||||
```
|
||||
|
||||
Logs(s):
|
||||
|
||||
```text
|
||||
# Paste your confis here.
|
||||
# Be sure to scrub any sensitive values
|
||||
```
|
||||
|
||||
**Additional context**
|
||||
|
||||
Add any other context about the problem here.
|
24
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
24
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
name: Feature request
|
||||
about: Suggest something!
|
||||
---
|
||||
|
||||
**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 [...]
|
||||
|
||||
**Describe the solution you'd like**
|
||||
|
||||
A clear and concise description of what you want to happen.
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
|
||||
**Explain any additional use-cases**
|
||||
|
||||
If there are any use-cases that would help us understand the use/need/value please share them as they can help us decide on acceptance and prioritization.
|
||||
|
||||
**Additional context**
|
||||
|
||||
Add any other context or screenshots about the feature request here.
|
12
.github/PULL_REQUEST_TEMPLATE
vendored
Normal file
12
.github/PULL_REQUEST_TEMPLATE
vendored
Normal file
|
@ -0,0 +1,12 @@
|
|||
<!-- Thanks for sending a pull request! Here are some tips for you:
|
||||
1. If this PR closes another issue, add 'closes #<issue number>' somewhere in the PR summary. GitHub will automatically close that issue when this PR gets merged. Alternatively, adding 'refs #<issue number>' will not close the issue, but help provide the reviewer more context.-->
|
||||
2. The PR title is formatted as follows: `proxy: frob the quux before blarfing`
|
||||
|
||||
**What this PR does / why we need it**:
|
||||
|
||||
**Special notes for your reviewer**:
|
||||
|
||||
**If applicable**:
|
||||
- [ ] this PR contains documentation
|
||||
- [ ] this PR contains unit tests
|
||||
- [ ] this PR has been tested for backwards compatibility
|
Loading…
Add table
Add a link
Reference in a new issue