Finish instructions, "Pushing changes upstream"
thoppe opened this issue · comments
Okay - I'm on it. The only thing is I want to talk about branching first... You've been doing it correctly. For each new feature, make a new branch, and submit a pr using that new branch. I've been taught that your own master branch should be "clean", in that you only update using upstream. That way nothing gets added in unless it's completed and free of bugs.
Do you agree?
Completely. You'll notice for these little changes I've been making I've
been a bit lazy. I can try to adhere to that format from now on. For tiny
edits (grammar, etc.) a new branch isn't strictly nes. but good practice.
For anything larger then yes, absolutely.
On Sun, Oct 19, 2014 at 7:54 PM, Austen Groener notifications@github.com
wrote:
Okay - I'm on it. The only thing is I want to talk about branching
first... You've been doing it correctly. For each new feature, make a new
branch, and submit a pr using that new branch. I've been taught that your
own master branch should be "clean", in that you only update using
upstream. That way nothing gets added in unless it's completed and free of
bugs.Do you agree?
—
Reply to this email directly or view it on GitHub
#28 (comment)
.
IMHO, the instructions for most users should just be "CLONE" and "RUN". Most of the extra stuff isn't needed except to upload to the repo (which is an advanced task).
There is no reason to make a fork if all you want to do is play with it and not push any edits back. A starting user will be inundated with so many other TeX things that this should be dead simple here.
Yea - In fact, I haven't even been following my own advice, mainly because there wasn't much in the way of content at first, so the commits I was making were small. I do want to put these more advanced instructions and tips here because I'm trying to design things so that it lasts. I don't want this to only be useful for a few of us who are graduating soon. If it's comprehensive (and written well), people can easily follow along and add more content over time.
Then split it into two sections - "Getting Started" should be just that.
Maybe create a new section "Adding content" and note that it is advanced.
On Sun, Oct 19, 2014 at 8:04 PM, Austen Groener notifications@github.com
wrote:
Yea - In fact, I haven't even been following my own advice, mainly because
there wasn't much in the way of content at first, so the commits I was
making were small. I do want to put these more advanced instructions and
tips here because I'm trying to design things so that it lasts. I don't
want this to only be useful for a few of us who are graduating soon. If
it's comprehensive (and written well), people can easily follow along and
add more content over time.—
Reply to this email directly or view it on GitHub
#28 (comment)
.
Okay - done. Let me know what you think.
It's always going to be in the public repo now, but I'd hide/obfuscate your email from harvesters from the public facing site.