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

doc: Add issue templates for example and test, and update the contribution guidelines and PR templates with corresponding examples #91

Merged
merged 1 commit into from
Dec 18, 2024
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
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/ex.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Report an issue with an example
description: Add or enhance examples.
labels: [ 'example' ]
body:
- type: markdown
attributes:
value: |
Thank you for helping us update our example!
- type: textarea
id: example_description
attributes:
label: Example Description
description: The specific details of the example.
validations:
required: true
- type: textarea
id: rationale
attributes:
label: Rationale
description: What problem does this example solve?
validations:
required: true
- type: textarea
id: additional_information
attributes:
label: Additional Information
description: What additional information do you need to provide?
validations:
required: false
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Report an issue with an test
description: Add or improve tests.
labels: [ 'test' ]
body:
- type: markdown
attributes:
value: |
Thank you for helping us update our test!
- type: textarea
id: test_description
attributes:
label: Test Description
description: The specific details of the test.
validations:
required: true
- type: textarea
id: rationale
attributes:
label: Rationale
description: What problem does this test solve?
validations:
required: true
- type: textarea
id: additional_information
attributes:
label: Additional Information
description: What additional information do you need to provide?
validations:
required: false
3 changes: 3 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ Please delete options that are not relevant:
- [ ] Bug fix
- [ ] New feature
- [ ] Documentation update
- [ ] Add or improve tests
- [ ] Add or enhance examples
- [ ] Miscellaneous tasks
- [ ] Other (please describe):

## How Has This Been Tested?
Expand Down
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@ Do note that our [Code of Conduct](CODE_OF_CONDUCT.md) applies to all Katharsis
| documentation | doc |
| enhancement | feat |
| bug | fix |
| example | ex |
| test | test |
| chore | chore |

Format: `<branch prefix>/<branch content>`
Expand Down
Loading