Skip to content

Commit

Permalink
chore: add GitHub Issues and PRs templates
Browse files Browse the repository at this point in the history
  • Loading branch information
ralgozino committed Dec 18, 2024
1 parent 9735b40 commit 219663f
Show file tree
Hide file tree
Showing 3 changed files with 125 additions and 0 deletions.
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Kubernetes (please complete the following information):**
- Kubernetes version: [e.g. 1.30.0]
- OPA Gatekeeper version: [e.g. 3.18.0]

**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: ''

---

**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.

**Additional context**
Add any other context or screenshots about the feature request here.
69 changes: 69 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
<!--
Thank you for contributing to this project! You must fill out the information below before we can review this pull request.
By explaining why you're making a change (or linking to an issue) and what changes you've made, we can triage your pull
request to the best possible team for review.
💡 **TIP**
Remember that you can always open a PR in draft status and fill all the information afterwards.
Opening a PR in draft allows other team members to knwo that you are working on this change, and let's you have a
place to track your work in progress.
When opening PRs in Draft, don't assign reviewers until the PR is ready for review. Once you are confortable with the
status of the PR and all the tests and CI is green, you can assign the reviewers to start the review process.
-->

### Summary 💡

<!-- Write a short summary of the changes that this PR introduces and the motivations -->

<!--
If there's an existing issue for your change, please link to it below inserting a link or the issue number.
If there's _not_ an existing issue, please open one first if the problem you are solving needs to be clearly identified,
for example is an error message that other users could get and google it.
-->
Closes:


<!-- If this PR is related to changes produced in other repos, like a Module or the distribution, please link them below. -->
Relates:


### Description 📝

<!--
Let us know what you are changing. Share anything that could provide the most context.
Feel free to add screenshots, code examples, the Description could end up in the release notes to help users adopt
the new feature or changes that you are introducing.
Expand on the reasoning behind some decision that you could have made to help reviewers understand the diff in the PR.
-->

### Breaking Changes 💔

<!--
If this PR introduces Breaking Changes, please include all the relevant information:
- What is changing
- What should the process for updating be
- Include examples if you can
-->

### Tests performed 🧪

<!--
Create a checklist with all the tests that you performed on your changes, being manual or automated.
If you are opening a Draft PR, you can use the checklist to track the tests that you want to do and mark them once you
have performed them.
Example:
- [ ] Tested the change with KFD version X.Y.Z
- [ ] Tested an upgrade from the previous version X
-->

### Future work 🔧

<!--
If there's any future work that could improve or extend on the work you've done in this PR you can mention it so
this PR can be used as context for that.
-->

0 comments on commit 219663f

Please sign in to comment.