Skip to content

Commit

Permalink
chore(.github): update issue-template and pull request template (#1)
Browse files Browse the repository at this point in the history
author: Ruiyang Sun<rockmagma02@gmail.com>
  • Loading branch information
rockmagma02 authored Apr 11, 2024
1 parent 5ec2ac6 commit 2ccdb4a
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 14 deletions.
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,19 @@ body:
- type: markdown
attributes:
value: |
Please do your best to make the issue as easy to act on as possible, and only submit here if there is clearly a problem with HttpX (ask in [Discussions]() first if unsure).
Please do your best to make the issue as easy to act on as possible, and only submit here if there is clearly a problem with HttpX (ask in [Discussions](https://github.com/rockmagma02/HttpX/discussions) first if unsure).
- type: checkboxes
id: steps
attributes:
label: Required prerequisites
description: Make sure you've completed the following steps before submitting your issue -- thank you!
options:
- label: I have read the documentation <>.
- label: I have read the documentation <http://httpx.ruiyangsun.com/documentation/httpx/>.
required: true
- label: I have searched the [Issue Tracker]() and [Discussions]() that this hasn't already been reported. (+1 or comment there if it has.)
- label: I have searched the [Issue Tracker](https://github.com/rockmagma02/HttpX/issues) and [Discussions](https://github.com/rockmagma02/HttpX/discussions) that this hasn't already been reported. (+1 or comment there if it has.)
required: true
- label: Consider asking first in a [Discussion]().
- label: Consider asking first in a [Discussion](https://github.com/rockmagma02/HttpX/discussions).
required: false

- type: input
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: 💬 Start a discussion
url: https://github.com/rockmagms02/HttpX/discussions/new
url: https://github.com/rockmagma02/HttpX/discussions
about: Please ask and answer questions here if unsure.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ body:
label: Required prerequisites
description: Make sure you've completed the following steps before submitting your issue -- thank you!
options:
- label: I have searched the [Issue Tracker]() and [Discussions]() that this hasn't already been reported. (+1 or comment there if it has.)
- label: I have searched the [Issue Tracker](https://github.com/rockmagma02/HttpX/issues) and [Discussions](https://github.com/rockmagma02/HttpX/discussions) that this hasn't already been reported. (+1 or comment there if it has.)
required: true
- label: Consider asking first in a [Discussion]().
- label: Consider asking first in a [Discussion](https://github.com/rockmagma02/HttpX/discussions).
required: false

- type: textarea
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/questions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ body:
options:
- label: I have read the documentation .
required: true
- label: I have searched the [Issue Tracker]() and [Discussions]() that this hasn't already been reported. (+1 or comment there if it has.)
- label: I have searched the [Issue Tracker](https://github.com/rockmagma02/HttpX/issues) and [Discussions](https://github.com/rockmagma02/HttpX/discussions) that this hasn't already been reported. (+1 or comment there if it has.)
required: true
- label: Consider asking first in a [Discussion]().
- label: Consider asking first in a [Discussion](https://github.com/rockmagma02/HttpX/discussions).
required: false

- type: textarea
Expand Down
10 changes: 5 additions & 5 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Why is this change required? What problem does it solve?
If it fixes an open issue, please link to the issue here.
You can use the syntax `close #15213` if this solves the issue #15213

- [ ] I have raised an issue to propose this change ([required]() for new features and bug fixes)
- [ ] I have raised an issue to propose this change ([required](https://github.com/rockmagma02/HttpX/issues) for new features and bug fixes)

## Types of changes

Expand All @@ -24,10 +24,10 @@ What types of changes does your code introduce? Put an `x` in all the boxes that
Go over all the following points, and put an `x` in all the boxes that apply.
If you are unsure about any of these, don't hesitate to ask. We are here to help!

- [ ] I have read the [CONTRIBUTION]() guide. (**required**)
- [ ] I have read the [CONTRIBUTION](https://github.com/rockmagma02/HttpX/blob/main/CODE_OF_CONDUCT.md) guide. (**required**)
- [ ] My change requires a change to the documentation.
- [ ] I have updated the tests accordingly. (*required for a bug fix or a new feature*)
- [ ] I have updated the documentation accordingly.
- [ ] I have reformatted the code using `make format`. (**required**)
- [ ] I have checked the code using `make lint`. (**required**)
- [ ] I have ensured `make test` pass. (**required**)
- [ ] I have checked my code via `pre-commit run --all-files` (**required**)
- [ ] I have ensured `swift test` pass. (**required**)
- [ ] I have add all license via `make addlicense` (**required**)

0 comments on commit 2ccdb4a

Please sign in to comment.