jquery / contribute.jquery.org

Developer documentation common to jQuery projects
https://contribute.jquery.org
Other
25 stars 76 forks source link

Deploying command is kind of confusing #116

Closed agcolom closed 9 years ago

agcolom commented 9 years ago

At the bottom of this section we say to use git push --tags origin master. However, everywhere else on the contribute site, we say to fork the repo, clone the fork which will be origin and add the main jquery repo as upstream. I'm proposing to replace git push --tags origin master to git push --tags upstream master. Any comments or objections?

jzaefferer commented 9 years ago

It looks to me like the parts using "upstream" are written for contributors, the one using "origin" for maintainers. We should keep those separate, so moving that "deploying" section elsewhere would be better than renaming the remote.

agcolom commented 9 years ago

@jzaefferer I agree with that. I'd be happy to maybe have a warning note then, reminding people that they should check whether they should push to origin or upstream (many maintainers started as contributors and would have the remotes inline with the contributor's recommendations. What do you think?

jzaefferer commented 9 years ago

That makes sense.

mgol commented 9 years ago

This seems confusing to me. Why not settle on origin for everything? I always use origin for the upstream repo (this is the default) and then add my fork if needed under my GitHub name as a remote name (i.e. mzgol). Changing upstream to origin just because someone became a maintainer seems weird.

agcolom commented 9 years ago

@mzgol My understanding is that contributors have been recommended to use upstream for the upstream/main repo and origin for their fork, and that is everywhere in the contribute site. I don't think we're going to change that. However, when used to follow the instructions on the contribute site, it can be confusing to suddenly be told to use origin and not upstream. While this section is for maintainers and it would be fair to expect maintainers to be aware of their setup and correct origin to upstream in that command, I think a reminder to check their remote before tagging and pushing can't do any harm and may help prevent mistakes.

mgol commented 9 years ago

Choice of specific names is personal taste so if we have upstream+origin everywhere then let's keep it. I just don't understand why we can't advise identical setup for maintainers as for contributors. After all, maintainers also submit PRs and also do it often from their own forks. I don't see the gains of separating those two cases.

For me it'd be easiest to understand if the only difference between Git setup of contributors & maintainers would be that the latter ones can push to upstream.

scottgonzalez commented 9 years ago

For me it'd be easiest to understand if the only difference between Git setup of contributors & maintainers would be that the latter ones can push to upstream.

That's exactly what @agcolom originally suggested.

mgol commented 9 years ago

Right, sorry for the confusion. +1 to @agcolom then.

arthurvr commented 9 years ago

:+1: to changing together with adding a note to make sure people double check.

agcolom commented 9 years ago

@jzaefferer @mzgol @scottgonzalez Please check the PR and let me know if the wording looks good to you or if anything needs changing. Here's a screenshot also: clarifydeploy