-
Notifications
You must be signed in to change notification settings - Fork 6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
GH-385: Simplify the PR template #406
base: main
Are you sure you want to change the base?
Conversation
- Removed 'Best practices' section for being redundant - Add square brackets for all the texts that should be replaced
What about even simpler approach? Ticket GH-406Changes
TestingEnvironment: https://environment.tld Checks
Markdown: ## Ticket GH-406
### Changes
- Simplify Drupal project template pull request template
### Testing
Environment: https://environment.tld
#### Checks
- [ ] check if headings are sized hierarchically
- [ ] check if template follows the [KISS principle](https://en.wikipedia.org/wiki/KISS_principle)
- [ ] ... |
Another template with really important topics:
There's also an interesting feature assignees: 'BrianGilbert'
<!--- Provide a general summary of your changes in the title above -->
## Types of changes
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
- [ ] Bug fix (a non-breaking change which fixes an issue)
- [ ] New feature (a non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
## Description
<!--- Describe your changes in detail -->
<!--- Why is this change required? What problem does it solve? -->
<!--- If it resolves an open issue, please link to the issue here. For example "Resolves: #1337" -->
## Checklist:
<!--- Put an `x` in all the boxes that apply. -->
<!--- If your change requires a documentation PR, please link it appropriately -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
- [ ] I have updated the documentation accordingly.
- [ ] I have added tests to cover my changes (if not applicable, please state why)
- [ ] All new and existing tests are passing.
## Screenshots/Media:
<!--- Add any screenshots or other type of media to demonstrate your change --> Source: https://github.com/Realityloop/foundry/blob/develop/.github/PULL_REQUEST_TEMPLATE.md |
Adding the ticket link into the title could be an option, but IMO it's way easier to simply copy-paste the URL under a certain heading instead of needing to do some formatting in the way of I maybe wouldn't go with the checklists, as checking and reordering those seem to be global and in cases where there are multiple reviewers, those might bring more confusion than benefit. The latter example looks quite good though. The HTML comments are a nice touch, but I think those would be mostly useful for someone that isn't that accustomed to creating PRs. Would the comments then be in the way of someone that's more experieced, I don't know. Balancing act, this ⚖️ |
Ticket
#385
Description
This PR is using the new simpler template 🌿
MD041/first-line-heading/first-line-h1: First line in a file should be a top-level heading
linting error, but IMO it doesn't make any sense to add level 1 heading here just for the sake of it.One thing I'd still consider removing is the
Setting up local environment
section, as I think those steps should be added underTesting instructions
section, even though the instructions can be used for both local and feature environment testing.Testing
Feature environment
No feature environment.
Setting up local environment
No local environment setting up required.
Testing instructions
See that the PR template makes sense.