Skip to content

Commit

Permalink
refactor: renew issue templates (chaos-mesh#4496)
Browse files Browse the repository at this point in the history
* refactor: renew issue templates

Signed-off-by: Yue Yang <[email protected]>

* Update pull_request_template.md

Signed-off-by: Yue Yang <[email protected]>

* Update e2e_test.yml

Signed-off-by: Yue Yang <[email protected]>

* Update integration_test.yml

Signed-off-by: Yue Yang <[email protected]>

---------

Signed-off-by: Yue Yang <[email protected]>
  • Loading branch information
g1eny0ung authored Sep 13, 2024
1 parent 7e11f64 commit bfe8736
Show file tree
Hide file tree
Showing 8 changed files with 97 additions and 60 deletions.
24 changes: 0 additions & 24 deletions .github/ISSUE_TEMPLATE/bug-report.md

This file was deleted.

38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Bug Report
description: Something does not work as expected, and I could provide a minimal reproducible example.
title: "[Bug]: "
labels:
- type/bug
assignees:
- g1eny0ung
- STRRL
body:
- type: input
id: chaos-mesh-version
attributes:
label: Chaos Mesh Version
description: What version of Chaos Mesh are you using?
placeholder: v2.x.x or master
required: true
- type: input
id: k8s-version
attributes:
label: Kubernetes Version
description: What version of Kubernetes are you using?
placeholder: v1.x.x
validations:
required: true
- type: textarea
id: bug
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: To Reproduce
description: Steps to reproduce the behavior.
placeholder: |
You can also include screenshots or any other relevant information here.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ blank_issues_enabled: false
contact_links:
- name: 🤔 Ask a question
url: https://github.com/chaos-mesh/chaos-mesh/discussions/new?category=q-a
about: Chaos Mesh not works as expected? Or not sure about how to use Chaos Mesh? Ask a question here!
about: Chaos Mesh does not work as expected? Or not sure about how to use Chaos Mesh? Ask a question here!
19 changes: 0 additions & 19 deletions .github/ISSUE_TEMPLATE/feature-request.md

This file was deleted.

36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Feature Request
description: Suggest an idea for this project
title: '[Feature]: '
labels:
- feature/new
assignees:
- g1eny0ung
- STRRL
body:
- type: markdown
attributes:
value: |
> [!TIP]
> Thanks for suggesting a feature! Please fill out the sections below to help us understand your request better.
>
> If you have a question or need help, please open a discussion instead.
- type: textarea
id: feature
attributes:
label: Feature request
description: Please describe the feature you'd like to see added to the project.
placeholder: I'd like to see [...]
validations:
required: true
- type: textarea
id: solution
attributes:
label: Proposed solution
description: Please describe a possible solution to the feature request.
placeholder: I think we could [...]
- type: textarea
id: context
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
placeholder: I have an idea [...]
33 changes: 17 additions & 16 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,21 @@
<!--
Thank you for contributing to Chaos Mesh!
If you're unsure where to start, please refer to the contributing doc:
https://github.com/chaos-mesh/chaos-mesh/blob/master/CONTRIBUTING.md
If you still have questions, please let us know via issues.
Please follow https://www.conventionalcommits.org/en/v1.0.0/ when you open a new PR:
-->
> [!IMPORTANT]
> Thank you for contributing to Chaos Mesh! Please fill out the template below to help us review your PR.
>
> If you are new to Chaos Mesh, please read the [contributing guide](https://github.com/chaos-mesh/chaos-mesh/blob/master/CONTRIBUTING.md) first.
>
> Please follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) when writing the PR title and commit messages.
## What problem does this PR solve?

<!-- Uncomment this line if some issues to close -->
<!-- Close #<issue number> -->
> [!TIP]
> Please replace this with a brief description of the problem this PR solves.
> You can also close #issue_number if this PR solves the issue.
## What's changed and how it works?

<!-- Uncomment this line if this PR is associated with a proposal -->
<!-- Proposal: [name](url) -->
> [!TIP]
> Please replace this with a brief description of the changes and how it works.
> You can also refer to a proposal or design doc if it exists.
## Related changes

Expand Down Expand Up @@ -55,7 +52,11 @@ Please follow https://www.conventionalcommits.org/en/v1.0.0/ when you open a new

## DCO

If you find the DCO check fails, please run commands like below (Depends on the actual situations. For example, if the failed commit isn't the most recent) to fix it:
If you find the DCO check fails, please run commands like below to fix it:

> [!TIP]
> Depends on actual situations, for example, if the failed commit isn't the most recent
> one, you can use `git rebase -i HEAD~n` to re-signoff the commit.
```shell
git commit --amend --signoff
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/e2e_test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ jobs:
files: |
.gitignore
**.md
.github/ISSUE_TEMPLATE/*
.github/pull_request_template.md
ui/**
.github/workflows/checklink.yaml
.github/checklink_config.json
Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/integration_test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@ on:
branches:
- master
paths-ignore:
- .gitignore
- "**.md"
- .github/ISSUE_TEMPLATE/*
- .github/pull_request_template.md
# Not available for frontend code for now.
- "ui/**"
- .github/workflows/checklink.yaml
Expand Down

0 comments on commit bfe8736

Please sign in to comment.