Skip to content

Commit cc099cb

Browse files
GuySartorelliGuySartorelli
committed
MNT Run module-standardiser
1 parent 157011b commit cc099cb

File tree

5 files changed

+155
-0
lines changed

5 files changed

+155
-0
lines changed

‎.github/ISSUE_TEMPLATE.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<!-- Blank templates are for use by maintainers only! If you aren't a maintainer, please go back and pick one of the issue templates. -->

‎.github/ISSUE_TEMPLATE/1_bug_report.yml

+72
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
name: 🪳 Bug Report
2+
description: Tell us if something isn't working the way it's supposed to
3+
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
We strongly encourage you to [submit a pull request](https://docs.silverstripe.org/en/contributing/code/) which fixes the issue.
9+
Bug reports which are accompanied with a pull request are a lot more likely to be resolved quickly.
10+
- type: input
11+
id: affected-versions
12+
attributes:
13+
label: Module version(s) affected
14+
description: |
15+
What version of _this module_ have you reproduced this bug on?
16+
Run `composer info` to see the specific version of each module installed in your project.
17+
If you don't have access to that, check inside the help menu in the bottom left of the CMS.
18+
placeholder: x.y.z
19+
validations:
20+
required: true
21+
- type: textarea
22+
id: description
23+
attributes:
24+
label: Description
25+
description: A clear and concise description of the problem
26+
validations:
27+
required: true
28+
- type: textarea
29+
id: how-to-reproduce
30+
attributes:
31+
label: How to reproduce
32+
description: |
33+
⚠️ This is the most important part of the report ⚠️
34+
Without a way to easily reproduce your issue, there is little chance we will be able to help you and work on a fix.
35+
- Please, take the time to show us some code and/or configuration that is needed for others to reproduce the problem easily.
36+
- If the bug is too complex to reproduce with some short code samples, please reproduce it in a public repository and provide a link to the repository along with steps for setting up and reproducing the bug using that repository.
37+
- If part of the bug includes an error or exception, please provide a full stack trace.
38+
- If any user interaction is required to reproduce the bug, please add an ordered list of steps that are required to reproduce it.
39+
- Be as clear as you can, but don't miss any steps out. Simply saying "create a page" is less useful than guiding us through the steps you're taking to create a page, for example.
40+
placeholder: |
41+
42+
#### Code sample
43+
```php
44+
45+
```
46+
47+
#### Reproduction steps
48+
1.
49+
validations:
50+
required: true
51+
- type: textarea
52+
id: possible-solution
53+
attributes:
54+
label: Possible Solution
55+
description: |
56+
*Optional: only if you have suggestions on a fix/reason for the bug*
57+
Please consider [submitting a pull request](https://docs.silverstripe.org/en/contributing/code/) with your solution! It helps get faster feedback and greatly increases the chance of the bug being fixed.
58+
- type: textarea
59+
id: additional-context
60+
attributes:
61+
label: Additional Context
62+
description: "*Optional: any other context about the problem: log messages, screenshots, etc.*"
63+
- type: checkboxes
64+
id: validations
65+
attributes:
66+
label: Validations
67+
description: "Before submitting the issue, please make sure you do the following:"
68+
options:
69+
- label: Check that there isn't already an issue that reports the same bug
70+
required: true
71+
- label: Double check that your reproduction steps work in a fresh installation of [`silverstripe/installer`](https://github.com/silverstripe/silverstripe-installer) (with any code examples you've provided)
72+
required: true

‎.github/ISSUE_TEMPLATE/2_feature_request.yml

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: 🚀 Feature Request
2+
description: Submit a feature request (but only if you're planning on implementing it)
3+
body:
4+
- type: markdown
5+
attributes:
6+
value: |
7+
Please only submit feature requests if you plan on implementing the feature yourself.
8+
See the [contributing code documentation](https://docs.silverstripe.org/en/contributing/code/#make-or-find-a-github-issue) for more guidelines about submitting feature requests.
9+
- type: textarea
10+
id: description
11+
attributes:
12+
label: Description
13+
description: A clear and concise description of the new feature, and why it belongs in core
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: more-info
18+
attributes:
19+
label: Additional context or points of discussion
20+
description: |
21+
*Optional: Any additional context, points of discussion, etc that might help validate and refine your idea*
22+
- type: checkboxes
23+
id: validations
24+
attributes:
25+
label: Validations
26+
description: "Before submitting the issue, please confirm the following:"
27+
options:
28+
- label: You intend to implement the feature yourself
29+
required: true
30+
- label: You have read the [contributing guide](https://docs.silverstripe.org/en/contributing/code/)
31+
required: true
32+
- label: You strongly believe this feature should be in core, rather than being its own community module
33+
required: true
34+
- label: You have checked for existing issues or pull requests related to this feature (and didn't find any)
35+
required: true

‎.github/ISSUE_TEMPLATE/config.yml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Security Vulnerability
4+
url: https://docs.silverstripe.org/en/contributing/issues_and_bugs/#reporting-security-issues
5+
about: ⚠️ We do not use GitHub issues to track security vulnerability reports. Click "open" on the right to see how to report security vulnerabilities.
6+
- name: Support Question
7+
url: https://www.silverstripe.org/community/
8+
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.

‎.github/PULL_REQUEST_TEMPLATE.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
<!--
2+
Thanks for contributing, you're awesome! ⭐
3+
4+
Please read https://docs.silverstripe.org/en/contributing/code/ if you haven't contributed to this project recently.
5+
-->
6+
## Description
7+
<!--
8+
Please describe expected and observed behaviour, and what you're fixing.
9+
For visual fixes, please include tested browsers and screenshots.
10+
-->
11+
12+
## Manual testing steps
13+
<!--
14+
Include any manual testing steps here which a reviewer can perform to validate your pull request works correctly.
15+
Note that this DOES NOT replace unit or end-to-end tests.
16+
-->
17+
18+
## Issues
19+
<!--
20+
List all issues here that this pull request fixes/resolves.
21+
If there is no issue already, create a new one! You must link your pull request to at least one issue.
22+
-->
23+
- #
24+
25+
## Pull request checklist
26+
<!--
27+
PLEASE check each of these to ensure you have done everything you need to do!
28+
If there's something in this list you need help with, please ask so that we can assist you.
29+
-->
30+
- [ ] The target branch is correct
31+
- See [picking the right version](https://docs.silverstripe.org/en/contributing/code/#picking-the-right-version)
32+
- [ ] All commits are relevant to the purpose of the PR (e.g. no debug statements, unrelated refactoring, or arbitrary linting)
33+
- Small amounts of additional linting 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.
34+
- [ ] The commit messages follow our [commit message guidelines](https://docs.silverstripe.org/en/contributing/code/#commit-messages)
35+
- [ ] The PR follows our [contribution guidelines](https://docs.silverstripe.org/en/contributing/code/)
36+
- [ ] Code changes follow our [coding conventions](https://docs.silverstripe.org/en/contributing/coding_conventions/)
37+
- [ ] This change is covered with tests (or tests aren't necessary for this change)
38+
- [ ] Any relevant User Help/Developer documentation is updated; for impactful changes, information is added to the changelog for the intended release
39+
- [ ] CI is green

0 commit comments

Comments
 (0)