From f0ccd66f7f4d8052c2896d8f122e1d7b6f584bac Mon Sep 17 00:00:00 2001 From: Guy Sartorelli Date: Thu, 21 Dec 2023 11:09:32 +1300 Subject: [PATCH] MNT Run module-standardiser --- .github/ISSUE_TEMPLATE.md | 1 + .github/ISSUE_TEMPLATE/1_docs_issue.yml | 34 +++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 ++++++ .github/PULL_REQUEST_TEMPLATE.md | 32 +++++++++++++++++++++++ 4 files changed, 75 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/1_docs_issue.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 000000000..cb5f05802 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1 @@ + diff --git a/.github/ISSUE_TEMPLATE/1_docs_issue.yml b/.github/ISSUE_TEMPLATE/1_docs_issue.yml new file mode 100644 index 000000000..478d38479 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1_docs_issue.yml @@ -0,0 +1,34 @@ +# This will be in the developer-docs and user help repos only +name: 📖 Documentation issue +description: Report an issue regarding the documentation content +body: + - type: markdown + attributes: + value: | + We strongly encourage you to [submit a pull request](https://docs.silverstripe.org/en/contributing/documentation/) which resolves the issue. + Issues which are accompanied with a pull request are a lot more likely to be resolved quickly. + - type: textarea + id: pages-affected + attributes: + label: Pages affected + description: A list of links of pages which are affected by this issue + placeholder: | + + - [Getting Started](https://docs.silverstripe.org/en/5/getting_started/) + validations: + required: true + - type: textarea + id: description + attributes: + label: Description + description: A clear and concise description of the problem you've found in the documentation + validations: + required: true + - type: checkboxes + id: validations + attributes: + label: Validations + description: "Before submitting the issue, please make sure you do the following:" + options: + - label: Check that there isn't already an issue that reports the same problem + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..f76520032 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: true +contact_links: + - name: Security Vulnerability + url: https://docs.silverstripe.org/en/contributing/issues_and_bugs/#reporting-security-issues + about: ⚠️ We do not use GitHub issues to track security vulnerability reports. Click "open" on the right to see how to report security vulnerabilities. + - name: Support Question + url: https://www.silverstripe.org/community/ + about: We use GitHub issues only to discuss bugs and new features. For support questions, please use one of the support options available in our community channels. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..c63eb1fa3 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,32 @@ + +## Description + + +## Issues + +- # + +## Pull request checklist + +- [ ] The target branch is correct + - See [branches and commit messages](https://docs.silverstripe.org/en/contributing/documentation#branches-and-commit-messages) +- [ ] All commits are relevant to the purpose of the PR (e.g. no TODO comments, unrelated rewording/restructuring, or arbitrary changes) + - Small amounts of additional changes are usually okay, but if it makes it hard to concentrate on the relevant changes, ask for the unrelated changes to be reverted, and submitted as a separate PR. +- [ ] The commit messages follow our [commit message guidelines](https://docs.silverstripe.org/en/contributing/code/#commit-messages) +- [ ] The PR follows our [contribution guidelines](https://docs.silverstripe.org/en/contributing/documentation/) +- [ ] The changes follow our [writing style guide](https://docs.silverstripe.org/en/contributing/documentation/#writing-style) +- [ ] Code examples follow our [coding conventions](https://docs.silverstripe.org/en/contributing/coding_conventions/) +- [ ] CI is green