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

fix format and change the issue template #113

Merged
merged 1 commit into from
Nov 28, 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
138 changes: 68 additions & 70 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,70 +1,68 @@
name: 🐛 Bug report
description: Describe a problem
labels: bug
title: '[Bug]'

body:
- type: markdown
attributes:
value: |
Some general tips:

- Is this really a problem?
- Is this a problem here?
- Can this be solved in a different way?

- type: checkboxes
id: initial-checklist
attributes:
label: Initial checklist
options:
# - label: I agree to follow the [code of conduct](https://github.com/libi/dcron/blob/main/CODE_OF_CONDUCT.md)
# required: true
- label: I searched [issues](https://github.com/libi/dcron/issues) and [discussions](https://github.com/libi/dcron/discussions) and couldn’t find anything (or linked relevant results below)
required: true

- type: input
id: affected-versions
attributes:
label: Affected packages and versions
description: Please test using the latest version of the relevant packages to make sure your issue has not already been fixed.
validations:
required: true

- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to reproduce
description: How did this happen? Please provide a [minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example).
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: What should happen?
validations:
required: true

- type: textarea
id: actual-behavior
attributes:
label: Actual behavior
description: What happens instead?
validations:
required: true

- type: dropdown
id: operating-system
attributes:
label: OS
description: What operating system are you using?
multiple: true
options:
- Windows
- Linux
- macOS
- Other (please specify in steps to reproduce)
validations:
required: false
name: 🐛 Bug report
description: Describe a problem
labels: bug
title: '[Bug]'

body:
- type: markdown
attributes:
value: |
Some general tips:

- Is this really a problem?
- Is this a problem here?
- Can this be solved in a different way?

- type: checkboxes
id: initial-checklist
attributes:
label: Initial checklist
options:
- label: I searched [issues](https://github.com/libi/dcron/issues) and [discussions](https://github.com/libi/dcron/discussions) and couldn’t find anything (or linked relevant results below)
required: true

- type: input
id: affected-versions
attributes:
label: Affected packages and versions
description: Please test using the latest version of the relevant packages to make sure your issue has not already been fixed.
validations:
required: true

- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to reproduce
description: How did this happen? Please provide a [minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example).
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: What should happen?
validations:
required: true

- type: textarea
id: actual-behavior
attributes:
label: Actual behavior
description: What happens instead?
validations:
required: true

- type: dropdown
id: operating-system
attributes:
label: OS
description: What operating system are you using?
multiple: true
options:
- Windows
- Linux
- macOS
- Other (please specify in steps to reproduce)
validations:
required: false
94 changes: 47 additions & 47 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,47 +1,47 @@
name: 🚀 Feature request
description: Suggest an idea
labels: enhancement
title: '[Feature]'
body:
- type: markdown
attributes:
value: |
Some general tips:
- Is this really a problem?
- Is this a problem here?
- type: checkboxes
id: initial-checklist
attributes:
label: Initial checklist
options:
- label: I agree to follow the [code of conduct](https://github.com/libi/dcron/blob/main/CODE_OF_CONDUCT.md)
required: true
- label: I searched [issues](https://github.com/libi/dcron/issues) and [discussions](https://github.com/libi/dcron/discussions) and couldn’t find anything (or linked relevant results below)
required: true
- type: textarea
id: problem
attributes:
label: Problem
description: Please describe the problem you are trying to solve here.
validations:
required: true
- type: textarea
id: solution
attributes:
label: Solution
description: What should happen? Please describe the desired behavior.
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives
description: What are the alternative solutions? Can this be solved in a different way?
validations:
required: true
name: 🚀 Feature request
description: Suggest an idea
labels: enhancement
title: '[Feature]'

body:
- type: markdown
attributes:
value: |
Some general tips:

- Is this really a problem?
- Is this a problem here?

- type: checkboxes
id: initial-checklist
attributes:
label: Initial checklist
options:
- label: I agree to follow the [CONTRIBUTING](https://github.com/libi/dcron/blob/master/CONTRIBUTING.md)
required: true
- label: I searched [issues](https://github.com/libi/dcron/issues) and [discussions](https://github.com/libi/dcron/discussions) and couldn’t find anything (or linked relevant results below)
required: true

- type: textarea
id: problem
attributes:
label: Problem
description: Please describe the problem you are trying to solve here.
validations:
required: true

- type: textarea
id: solution
attributes:
label: Solution
description: What should happen? Please describe the desired behavior.
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternatives
description: What are the alternative solutions? Can this be solved in a different way?
validations:
required: true
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ Thank you for everyone join DCRON project, before you adding one issue or creati

Please don't check the **Copy the master branch only** when you fork this project, you may use them in the future.

# Format tips

Please confirm every line in your commit files don't have `\r\n` in the end of line.

# Pull Request Submit Specifications
## 1. BugFix
Bugfix PR should base on master branch, and it will be merged into master.
Expand Down
4 changes: 4 additions & 0 deletions CONTRIBUTING_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@

请在 Fork 本项目时,不要勾选 **Copy the master branch only**,其他分支或许你用得到

# 格式注意事项

请保证提交的每一行都不以`\r\n`结尾

# Pull Request 提交规范
## 1. BugFix
Bugfix PR请以master分支为基础分支,在通过代码review后合入master
Expand Down