-
Notifications
You must be signed in to change notification settings - Fork 4
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
Create pull request template #821
Conversation
✅ Deploy Preview for taho-development ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
@ioay @jagodarybacka @Shadowfiend I'd appreciate your comment here, some improvement are also really welcomed :) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks ok to me now. Leaving for other folks to chime in.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So what I would like to achieve with a PR template is both:
- having unified structure of PR descriptions
- improving or keeping the same the effort of creating the PR description while providing the value to PR reviewers
I would say that to achieve the points above we should aim to have to type as little text as possible while including as much context as possible.
I feel like this template contains too much text and includes details that are obfuscating the message of the PR.
My suggestions:
- type the word "Resolves " instead of describing what this section is about - will save us time removing that text. In general I think we don't need to have the descriptions of these sections - either we will be removing them (additional time to remove that text) or we will leave them in the cretaed PR (additional effort for the reader to ignore that text while reading)
- we just need one bullet point or checklist item prepared in the template to be able to add next by clicking "enter" while typing
- "description" and "what has been done" are basically the same thing most of the time
- why do we need to check the type of the PR? What kind of value is it providing? I believe it should be obvious looking at the title or description. I would find it valuable if we could filter by the type (so it would be a label for example) but idk if this is necessary
- screenshots are optional and IMO they should be below the testing checklist (but its just my preference to keep the text content together and see the testing progress first)
In general I like the template idea but we should be careful while designing that thing to avoid adding more work than we had before 😄
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like it now, do we want to undraft?
Pull request template
This PR creates a pull request template that will be used for all pull requests, to make them consistent and always provide enough information about what was changes / what was added
The PR template looks like this:
Issues connected
Resolves
What has been done
Testing
Screenshots / images / videos
Please provide assets necessary for the PR (remove if not applicable)
Open to suggestions, what should be changed / what should be added