Skip to content
This repository was archived by the owner on Aug 15, 2019. It is now read-only.

Conversation

bileschi
Copy link
Contributor

@bileschi bileschi commented May 14, 2018

DEV adds default pull request template to help remind contributors to use PR commit message tags.

image


This change is Reviewable

@bileschi bileschi requested review from nsthorat and caisq May 14, 2018 20:11
@nsthorat
Copy link
Contributor

Thanks for looking into this.

So the PR description isn't actually what matters, it's what we end up putting in the git commit message. Is there a way to set up the template for that instead?

@nsthorat
Copy link
Contributor

And to be clear, the PR description doesn't automatically get added to the commit message.

@nsthorat
Copy link
Contributor

:lgtm_strong:


Review status: 0 of 1 files reviewed at latest revision, all discussions resolved, some commit checks failed.


Comments from Reviewable

@caisq
Copy link
Collaborator

caisq commented May 14, 2018

:lgtm_strong:


Review status: 0 of 1 files reviewed at latest revision, all discussions resolved, some commit checks pending.


Comments from Reviewable

@dsmilkov
Copy link
Contributor

We still need to manually copy the PR desc into the commit message when we squash and merge right? or does this template show up in the squash-and-merge message as well?

@bileschi
Copy link
Contributor Author

@dsmilkov The user still needs to write their own squash & merge commit message.

Unfortunately there does not seem to be a good way to automatically populate the commit message. It would require modifying the .git/config in a way that would not survive cloning the repo. We could hack something up, perhaps a script, which modifies the user's config, but that sounds pretty risky & ugly.

@bileschi bileschi merged commit d0b6c63 into master May 15, 2018
@nsthorat nsthorat deleted the add-pr-template branch May 15, 2018 13:44
@nsthorat
Copy link
Contributor

We still have to copy paste it, but this will at least help us remember.

@manrajgrover
Copy link
Contributor

I feel we should move templates and contributing file to .github folder which seems to be a general convention.

@manrajgrover
Copy link
Contributor

I was thinking if we can automate adding PR title as commit title and PR description as commit description. Turns out there is already a Chrome extension that does it. Sharing it here: https://github.com/sindresorhus/refined-github

@dsmilkov
Copy link
Contributor

I installed the extension and works great for me (copies the PR title and description into the commit)!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants