-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Improve Pull Request template #374
Conversation
Thanks for figuring out the branch issue on this, @agisilaos, and for reopening. This is a good change, but I'd like to add a bit more language around it so that it matches the tone of the first two instructions ("First, ...", "Next, ..."). Something like this, maybe?
I also couldn't help but notice that you didn't delete the instructions. I'm curious: Is that a convention that you're unfamiliar with, and if so should we be more explicit about asking folks to delete each line as they check it off the list? Thanks again! |
I really like your proposal @shawnbot! Makes total sense. I will add it with my next commit. Indeed it's a convention that I'm unfamiliar with. I think It will make more sense if we create a checklist for these 3 steps like it's presented below:
Also, I have another idea to go your suggestion regarding this message even further: Proposal for the message: Last minute thoughts: |
That's a great idea! Lerna does this in its pull request template, and it was pretty nice to use. I could see just having a checklist item for whether it fixes any issues, e.g. something like:
|
Also fixed the naming of the `Fixes: #` with the help of @shawnbot.
Perfect! I'm so happy with the changes 💯 |
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 great! Thanks for the contributions. ⭐️✨⚡️🌈
↖ First, change the base branch from "master" to "dev".
↑ Next, briefly describe your proposal in the title.
Hey, everyone, this is my first contribution to primer-css and I would love to know what you think. So I was thinking of adding a new line into the PR Template:
Fixes: #
That way when someone creates a Pull request can mention the issue that has been fixed more easily.
Benefits
I don't know if my logic here is correct so I would love to know what you think about this potential change.
P.s Love how you build primer-css in the open. Learned a lot of things about how to communicate more effectively through issues and PR's, write better commit messages and organize my open source projects.
/cc @primer/ds-core