Skip to content
This repository has been archived by the owner on Aug 16, 2024. It is now read-only.

Commit

Permalink
Merge pull request #10 from strvcom/docs/templates
Browse files Browse the repository at this point in the history
docs: add github templates
  • Loading branch information
Tomáš Kocman authored Aug 10, 2022
2 parents 4a081c2 + 3f7ca2d commit 9d7f8e4
Show file tree
Hide file tree
Showing 3 changed files with 94 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''
---

# Description
Use a clear and descriptive title for the issue to identify the problem. Describe the bug in general.

# Steps to reproduce
Provide specific examples to reproduce the issue. Please also list any relevant details for your configuration.

- [ ] Step 1
- [ ] Step 2
- [ ] ...

**Run Configuration**:
- Package version:
- Go version (`go version`):
- Operating system (`sw_vers` for MacOS, `lsb_release -a` for Linux):
- Processor architecture (`uname -a`):

### Actual behavior
Describe the issue. Be as descriptive as possible.

### Expected behavior
Explain what behavior you expected instead and why.

# Checklist
- [ ] I have read the [CONTRIBUTING.md](https://github.com/strvcom/strv-backend-go-env/blob/master/CONTRIBUTING.md).
- [ ] I have checked the [Q&A](https://github.com/strvcom/strv-backend-go-env/discussions/categories/q-a) for a list of common questions and problems.
- [ ] I have performed a search in [issues](https://github.com/strvcom/strv-backend-go-env/issues) and [discussions](https://github.com/strvcom/strv-backend-go-env/discussions) to see if the problem has already been reported.
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: feature
assignees: ''
---

# Description
Use a clear and descriptive title. Please include as many details as possible. Include the steps that you imagine you would take if the feature you're requesting existed.

Inspiration what to put in the description:
- **Is your feature request related to a problem? Please describe**.
A clear and concise description of what the problem is - e.g. 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.
- **Additional context**.
Add any other context or screenshots about the feature request.

# Feature usage
Provide specific examples to demonstrate the usage of the feature. Include copy-pasteable snippets as examples, ideally as Markdown code blocks.
- [ ] Step 1
- [ ] Step 2
- [ ] ...

# Benefits of the feature
Explain why this feature would be useful.

# Checklist
- [ ] I have read the [CONTRIBUTING.md](https://github.com/strvcom/strv-backend-go-env/blob/master/CONTRIBUTING.md).
- [ ] I have checked if I'm using the latest version and if I can get the desired behavior by changing the configuration. You might discover that the feature is already available.
- [ ] I have searched the existing [issues](https://github.com/strvcom/strv-backend-go-env/issues) and [discussions](https://github.com/strvcom/strv-backend-go-env/discussions) to see if the feature has already been suggested.
26 changes: 26 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Description
Please include a summary of the change and which issue it is related to, if possible. Include relevant motivation and context. List any requirements that are prerequisites to this change. Part of `CHANGELOG.md` can be used as the PR description.

Closes <issue-number> (e.g. `Closes #1`)

## Type of change
Delete options that are not relevant.
- [ ] Bug fix.
- [ ] New feature.
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected).
- [ ] Documentation update.

# How has this been tested
Describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.
- [ ] Test A
- [ ] Test B

# Checklist:
- [ ] Pull request is linked with the corresponding issue.
- [ ] Code follows the style guidelines of this project.
- [ ] Change is documented in `CHANGELOG.md`.
- [ ] I have performed a self-review of my code.
- [ ] I have commented on my code, particularly in hard-to-understand areas.
- [ ] I have made corresponding changes to the documentation (`README.md`, `openapi.yaml`).
- [ ] I have added tests that prove my fix is effective or that my feature works.
- [ ] Unit tests pass with my changes.

0 comments on commit 9d7f8e4

Please sign in to comment.