-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(github): add code of conduct, pull request template, replace iss…
…ue templates with yml version (#680) * feat: add code of conduct, pull request template, replace issue templates with yml version * style(.github): fix indent * chore: update link and fix issue -> pull request --------- Co-authored-by: Bruno Alla <browniebroke@users.noreply.github.com>
- Loading branch information
1 parent
b8cadc0
commit 8f5c58e
Showing
7 changed files
with
168 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# CODE OF CONDUCT | ||
|
||
(This project does not have a CODE OF CONDUCT defined.) |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
name: Bug report | ||
description: Create a report to help us improve | ||
labels: [bug] | ||
body: | ||
- type: textarea | ||
id: description | ||
attributes: | ||
label: Describe the bug | ||
description: A clear and concise description of what the bug is. | ||
placeholder: Describe the bug | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: reproduce | ||
attributes: | ||
label: To Reproduce | ||
description: Steps to reproduce the behavior. | ||
placeholder: To Reproduce | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: context | ||
attributes: | ||
label: Additional context | ||
description: Add any other context about the problem here. | ||
placeholder: Additional context | ||
- type: input | ||
id: version | ||
attributes: | ||
label: Version | ||
description: Version of the project. | ||
placeholder: Version | ||
validations: | ||
required: true | ||
- type: input | ||
id: platform | ||
attributes: | ||
label: Platform | ||
description: Platform where the bug was found. | ||
placeholder: "Example: Windows 11 / macOS 12.0.1 / Ubuntu 20.04" | ||
validations: | ||
required: true | ||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: Code of Conduct | ||
description: By submitting this issue, you agree to follow our | ||
[Code of Conduct](https://github.com/{{ github_username }}/{{ project_slug }}/blob/main/.github/CODE_OF_CONDUCT.md). | ||
options: | ||
- label: I agree to follow this project's Code of Conduct. | ||
required: true | ||
- type: checkboxes | ||
id: no-duplicate | ||
attributes: | ||
label: No Duplicate | ||
description: Please check [existing issues](https://github.com/{{ github_username }}/{{ project_slug }}/issues) to avoid duplicates. | ||
options: | ||
- label: I have checked existing issues to avoid duplicates. | ||
required: true | ||
- type: markdown | ||
attributes: | ||
value: 👋 Have a great day and thank you for the bug report! |
This file was deleted.
Oops, something went wrong.
50 changes: 50 additions & 0 deletions
50
project/.github/ISSUE_TEMPLATE/2-feature-request.yml.jinja
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
name: Feature request | ||
description: Suggest an idea for this project | ||
labels: [enhancement] | ||
body: | ||
- type: textarea | ||
id: description | ||
attributes: | ||
label: Is your feature request related to a problem? Please describe. | ||
description: A clear and concise description of what the problem is. | ||
value: I'm always frustrated when | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: solution | ||
attributes: | ||
label: Describe alternatives you've considered | ||
description: A clear and concise description of any alternative solutions or features you've considered. | ||
placeholder: Describe alternatives you've considered | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: context | ||
attributes: | ||
label: Additional context | ||
description: Add any other context or screenshots about the feature request here. | ||
placeholder: Additional context | ||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: Code of Conduct | ||
description: By submitting this issue, you agree to follow our | ||
[Code of Conduct](https://github.com/{{ github_username }}/{{ project_slug }}/blob/main/CODE_OF_CONDUCT.md). | ||
options: | ||
- label: I agree to follow this project's Code of Conduct | ||
required: true | ||
- type: checkboxes | ||
id: willing | ||
attributes: | ||
label: Are you willing to resolve this issue by submitting a Pull Request? | ||
description: Remember that first-time contributors are welcome! 🙌 | ||
options: | ||
- label: Yes, I have the time, and I know how to start. | ||
- label: Yes, I have the time, but I don't know how to start. I would need guidance. | ||
- label: No, I don't have the time, although I believe I could do it if I had the time... | ||
- label: No, I don't have the time and I wouldn't even know how to start. | ||
validations: | ||
required: true | ||
- type: markdown | ||
attributes: | ||
value: 👋 Have a great day and thank you for the feature request! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: Questions | ||
url: https://github.com/{{ github_username }}/{{ project_slug }}/discussions/categories/q-a | ||
about: Please ask and answer questions here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
<!-- | ||
😀 Wonderful! Thank you for opening a pull request. | ||
By submitting this pull request, you agree to follow our [Code of Conduct](https://github.com/{{ github_username }}/{{ project_slug }}/blob/main/.github/CODE_OF_CONDUCT.md). | ||
Please fill in the information below to expedite the review | ||
and (hopefully) merge of your change. | ||
--> | ||
|
||
### Description of change | ||
|
||
<!-- | ||
Please be clear and concise what the change is intended to do, | ||
why this change is needed, and how you've verified that it | ||
corrects what you intended. | ||
In some cases it may be helpful to include the current behavior | ||
and the new behavior. | ||
If the change is related to an open issue, you can link it here. | ||
If you include `Fixes #0000` (replacing `0000` with the issue number) | ||
when this is merged it will automatically mark the issue as fixed and | ||
close it. | ||
--> | ||
|
||
### Pull-Request Checklist | ||
|
||
<!-- | ||
Please make sure to review and check all of the following to merge this PR. | ||
Note that there is no problem if they are not checked when this PR is created. | ||
If an item is not applicable, you can add "N/A" to the end. | ||
--> | ||
|
||
- [ ] Code is up-to-date with the `main` branch | ||
- [ ] This pull request follows the [contributing guidelines](https://github.com/{{ github_username }}/{{ project_slug }}/blob/main/CONTRIBUTING.md). | ||
- [ ] This pull request links relevant issues as `Fixes #0000` | ||
- [ ] There are new or updated unit tests validating the change | ||
- [ ] Documentation has been updated to reflect this change | ||
- [ ] The new commits follow conventions outlined in the [conventional commit spec](https://www.conventionalcommits.org/en/v1.0.0/), such as "fix(api): prevent racing of requests". | ||
|
||
> - If pre-commit.ci is failing, try `pre-commit run -a` for further information. | ||
> - If CI / test is failing, try `poetry run pytest` for further information. | ||
|
||
<!-- | ||
🎉 Thank you for contributing! | ||
--> |