diff options
-rw-r--r-- | .github/ISSUE_TEMPLATE/bug-report-template.md | 29 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/bug-report.md | 48 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/config.yml | 7 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/feature.md | 31 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/feature_request.md | 19 | ||||
-rw-r--r-- | .github/pull_request_template.md | 37 |
6 files changed, 113 insertions, 58 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug-report-template.md b/.github/ISSUE_TEMPLATE/bug-report-template.md deleted file mode 100644 index 6c03fc5a..00000000 --- a/.github/ISSUE_TEMPLATE/bug-report-template.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -name: Bug Report Template -about: A simple bug report template. - ---- - -## Description - -[provide a simple description of the bug] - -## Steps to Reproduce - -- [replace with a description of a step to reproduce the issue] -- [replace with a description of a step to reproduce the issue] -- [replace with a description of a step to reproduce the issue] - -## Expected Behavior -The expected behaviour is [provide a detailed description and, if necessary, screenshots]. - -## Actual Behavior -The actual behaviour is [provide a detailed description and, if necessary, screenshots]. - -## Environment -- Device Type: (e.g.: Desktop or Mobile) -- Operating System: (e.g.: Microsoft Windows or Ubuntu Linux) - - Version: (e.g.: 10 or 18.04) - -## Other -[provide any additional details that can be helpful] diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 00000000..a352db59 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,48 @@ +--- +name: Bug Report +about: Issues for reporting bugs with the bot. +title: '' +labels: 'type: bug' +assignees: '' + +--- + +## Description +<!-- Describe the bug you've found --> + + +## Steps to Reproduce +<!-- Detail the exact list of steps to be able to encounter the bug --> + + +## Expected Behaviour +<!-- Outline what you expect to occur, include screenshots if relevant --> + + +## Actual Behaviour +<!-- Outline what occurs instead of the expected behaviour, include screenshots if relevant --> + + +## Known Impacted Platforms +<!-- Replace [ ] with [x] to mark items --> + +- [ ] Web +- [ ] Desktop +- [ ] Android App +- [ ] iOS App + +## Possible Solutions +<!-- Detail any solutions you might have in mind to be able to resolve the bug --> + + +## Additional Details +<!-- Delete this section if not applicable --> + + +## Would you like to implement a fix? + +***Note: For high-priority or critical bugs, fixes may be implemented by staff.*** +<!-- Replace [ ] with [x] with your choice --> + +- [ ] I'd like to implement the bug fix +- [ ] Anyone can implement the bug fix diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..519294a0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,7 @@ +blank_issues_enabled: false +contact_links: + - name: Python Discord Community + url: https://discord.gg/python + about: Contributors must be part of the community, so be sure to join! + - name: Contributing Guide + url: https://pythondiscord.com/pages/contributing/seasonalbot/ diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md new file mode 100644 index 00000000..3ae1628c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.md @@ -0,0 +1,31 @@ +--- +name: Feature +about: Issues for requesting feature changes or additions. +title: '' +labels: 'status: planning, type: feature' +assignees: '' + +--- + +## Description +<!-- Describe your proposal in detail --> + + +## Reasoning +<!-- Outline how the proposal would be useful to the community --> + + +## Proposed Implementation +<!-- Detail any implementation you had in mind, including any screenshots if possible --> + + +## Additional Details +<!-- If alternate implementations were considered, add them here --> +<!-- Delete this section if there are no details to add --> + + +## Would you like to implement this yourself? +<!-- Replace [ ] with [x] with your choice --> + +- [ ] I'd like to implement this feature myself +- [ ] Anyone can implement this feature diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 04d31a5d..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: Feature request -about: A simple feature request template. - ---- - -Provide a simple description of how the feature would work. This should not include technical details, but should instead be a high level description of how the user experience would be when you used this feature. - -## Implementation details - -List the changes required for the implementation here. - -- [ ] Write the bot command -- [ ] Add the command to our README.md -- [ ] etc. - -## Additional information - -Provide any additional information or clarifications here. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index c8b15b09..d146be1d 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,21 +1,38 @@ --- name: Pull Request -about: A simple pull request template. -issue: Issue # if applicable +about: Request to pull code changes into the repository. +title: '' +assignees: '' --- -Provide a simple description of what the PR achieves. +## Relevant Issues +<!-- List relevant issue tickets here. --> +<!-- Say "Closes #0" for issues that the PR resolves, replacing 0 with the issue number. --> -## Pull Request Details -Please ensure your PR fulfills the following criteria: +## Description +<!-- Describe how you've implemented your changes. --> -- [ ] Have you joined the [PythonDiscord Community](https://pythondiscord.com/invite)? -- [ ] Were your changes made in a Pipenv environment? -- [ ] Does flake8 pass (```pipenv run lint```) +## Reasoning +<!-- Outline the reasoning for how it's been implemented. --> -## Additional information -Provide any additional information or clarifications here.
\ No newline at end of file +## Screenshots +<!-- Remove this section if the changes don't impact anything user-facing. --> +<!-- You can add images by just copy pasting them directly in the editor. --> + + +## Additional Details +<!-- Delete this section if not applicable. --> + + +## Did you: +<!-- These are required when contributing. --> +<!-- Replace [ ] with [x] to mark items as done. --> + +- [ ] Join the [**Python Discord Community**](https://discord.gg/python)? +- [ ] If dependencies have been added or updated, run `pipenv lock`? +- [ ] **Lint your code** (`pipenv run lint`)? +- [ ] Set the PR to **allow edits from contributors**? |