Unused PR template
MikeMcC399 opened this issue · 3 comments
Description
When I opened a PR I expected the PR template to be used, however no PR template was presented.
URL of Issue(s)
.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
Steps to replicate
- Create a new branch
- Create a commit in the new branch
- Push the commit to the repo
- Open a push request and note that no template is used. The body of the PR is blank.
Additional Information
The PR template .github/PULL_REQUEST_TEMPLATE/pull_request_template.md is unused.
If it was intended to be the default PR template, then it is in the wrong place.
The template is not automatically used when it is placed in the .github/PULL_REQUEST_TEMPLATE directory. It would need to be moved to the top level of the .github directory to be automatically used. This is the way it works in the main cypress-io/cypress > .github repo.
The directory .github/PULL_REQUEST_TEMPLATE is only usable if additional GitHub Action workflows are defined which set up appropriate template query parameters. This has not been done for the cypress-io/cypress-documentation repo.
Suggestion
- Remove the .github/PULL_REQUEST_TEMPLATE/pull_request_template.md template OR
- Move the .github/PULL_REQUEST_TEMPLATE/pull_request_template.md to the .github AND
- Review the template for up-to-date usefulness.
Reference
GitHub documentation
You can store your pull request template in the repository's visible root directory, the docs folder, or the hidden .github directory.
You can create a PULL_REQUEST_TEMPLATE/ subdirectory in any of the supported folders to contain multiple pull request templates, and use the template query parameter to specify the template that will fill the pull request body.
My preference is to delete the template.
If there is a need to have a default PR template then I think it should be redesigned, taking account also of the preview provided by Netlify.
@MikeMcC399 Yah, I would delete this template. I'm not even sure where it came from.
I'm not sure what we would need for a template in this repo besides Closes # and a Description. It's usually pretty self evident what the changes are for the docs changes.
Yah, I would delete this template. I'm not even sure where it came from.
I'm not sure what we would need for a template in this repo besides
Closes #and a Description. It's usually pretty self evident what the changes are for the docs changes.
- Thank you very much for your feedback! I stumbled on this issue because the .github/PULL_REQUEST_TEMPLATE/plugin_template.md contains a bad link to the tutorial deleted in #5624. I was going to correct the link, then I realized that the templates in the directory .github/PULL_REQUEST_TEMPLATE were not being used, so there was not much to be gained by correcting the bad link.
I will submit a PR to delete the two templates in .github/PULL_REQUEST_TEMPLATE as neither of them can be used (apart from manually - but most people would not even look for them manually, let alone find them).