Skip to content

Clarify step 4 in pull request template #110

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

Closed
willingc opened this issue Feb 12, 2017 · 8 comments
Closed

Clarify step 4 in pull request template #110

willingc opened this issue Feb 12, 2017 · 8 comments

Comments

@willingc
Copy link
Collaborator

In both the devguide and CPython repos, the PR template (see example) lists the steps for a new contributor to sign the CLA, add their GitHub username to bpo, and check if the bpo account shows the CLA as signed.

Adding a small visual to "Step 4: Adding GitHub user name to bpo account" would probably save maintainers from reminding people to add their GitHub user name. A small graphic similar to this would help:

bpo_gh

@berkerpeksag
Copy link
Member

Did we get any reports about this? I think the steps are quite easy to follow. The only vague part is

If you just signed the CLA, please wait at least **a day**  [...]

IMO python/the-knights-who-say-ni#89 will make step 4 clearer.

@willingc
Copy link
Collaborator Author

@berkerpeksag Just a suggestion. I've seen a number of new contributors neglect adding their GitHub address to bpo, and then a maintainer has to remind.

Looking at it from someone familiar with bpo, I agree that the text is clear. Yet, a new contributor will likely benefit from further guidance since they will likely not be familiar with bpo.

@brettcannon
Copy link
Member

My only worry with adding an image is it will make an already large comment even larger and I would be worried about making it come off as intimidating (I tried to make it as friendly and self-explanatory as possible at the same time, hence its current length). I'm not opposed to providing a link to the image in the message, though.

@willingc
Copy link
Collaborator Author

@brettcannon Link to an image would be wonderful. 😄

@brettcannon
Copy link
Member

@willingc any ideas on where to host the image to provide the link? Or should we just link to https://cloud.githubusercontent.com/assets/2680980/22867185/d3aedcf8-f137-11e6-8469-d5f7861a1073.png ?

@willingc
Copy link
Collaborator Author

The PNG is pretty small. Perhaps create a static directory where the Pull Request template lives (knights who say ni repo?) and put it there. Though I suppose linking as you mention would be fine too.

@brettcannon
Copy link
Member

Let's try using the link we already have. Did you want to make a PR for the bot, @willingc ?

@willingc
Copy link
Collaborator Author

Sure. I'll add it later this afternoon. Thanks @brettcannon.

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

No branches or pull requests

3 participants