Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(issue and pr template): minor improvement #347

Merged
merged 1 commit into from
Jan 27, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 12 additions & 13 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,35 +2,34 @@
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
type: Bug
assignees: ''

---

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

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

**Expected behavior**
Feel free to add any files or code snippets that can help us to reproduce the issue. For example, a `furyctl.yaml` file or a `furyctl` command.

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

**Screenshots**
### 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]
### Software versions
Please complete the following information:

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

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

---

**Is your feature request related to a problem? Please describe.**
### 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**
### Describe the solution you'd like
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
### Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
### Additional context
Add any other context or screenshots about the feature request here.
19 changes: 11 additions & 8 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
<!--
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
Opening a PR in draft allows other team members to know 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.
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 💡
Expand All @@ -19,6 +21,7 @@ status of the PR and all the tests and CI is green, you can assign the reviewers

<!--
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.
-->
Expand All @@ -33,11 +36,10 @@ Relates:

<!--
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.
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 💔
Expand All @@ -53,8 +55,9 @@ If this PR introduces Breaking Changes, please include all the relevant informat

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

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
Expand Down