OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.

 


Help: OASIS Mailing Lists Help | MarkMail Help

dita message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]


Subject: Command-line equivalents for SourceTree actions


FYI.

Best,
Kris

Kristen James Eberlein
Chair, OASIS DITA Technical Committee
Principal consultant, Eberlein Consulting
www.eberleinconsulting.com
+1 919 622-1501; kriseberlein (skype)



-------- Forwarded Message --------
Subject: Re: PowerPoint deck for GitHub and SourceTree training
Date: Tue, 25 Sep 2018 10:54:18 -0500
From: Robert D Anderson <robander@us.ibm.com>
To: Kristen James Eberlein <kris@eberleinconsulting.com>


OK, not sure how best to fit these into the existing slides (there's not really room on some slides, don't know if we want extra slides to show SourceTree and then show command line, or have a command line appendix at the end, or ...)

But to get the commands down now...

Slide 6 cloning -- using the same repo you showed:


Slide 7 adding upstream -- this example adds the main OASIS spec repo as upstream:
Slide 8 fetching from upstream:
  • git fetch upstream

Slide 10 creating a branch - this command both creates a new branch based on the upstream DITA-2.0 branch and checks out the new branch:
  • git checkout -b newBranchName upstream/DITA-2.0

Slide 11 committing -- from the command line first you need to add any changed file or directory of files, then commit:
  • Useful command to see what is not staged for committing - this will show files that have been added to the commit already, followed by files that have changed but have not been added:
    git status
  • To add a file, for example the element reference topic for topic:
    git add specification/langRef/base/topic.dita
  • To add all of the changes or new files you've put into the base element reference directory:
    git add specification/langRef/base/
  • To commit your changes use git commit, followed by -m "Message". Optional: if there is a github issue open for the change your are making, you can reference that issue using the issue number in the message, such as #123 -- this will automatically add links in between that issue and your commit. I also like to add the -s flag as well which signs the commit to mean "This is all created by the the owner of this github account".
    git commit -s -m "Message describing the commit #123"

Slide 12 pushing changes to your fork -- this assumes your changes are in the branch newBranchName as above:
git push origin newBranchName

Everything else takes place at github rather than in the command line.

I do see one suggested update for slide 17 best practices for commit messages... We should list as a best practice that if there is an open issue for your specific change, you should include that issue number in your commit. For example, if you are making a specification change related to issue 105 for redesigning chunking, including #105 in your commit message will automatically add linking between that existing issue and your new commit, regardless of whether a pull request exists yet.
Robert D. Anderson
DITA-OT lead and Co-editor DITA 1.3 specification
Marketing Services Center

E-mail: robander@us.ibm.com

11501 BURNET RD,, TX, 78758-3400, AUSTIN, USA
IBM


Inactive hide details for Kristen James Eberlein
        ---09/18/2018 08:15:13 AM----- Best,Kristen James Eberlein ---09/18/2018 08:15:13 AM----- Best,

From: Kristen James Eberlein <kris@eberleinconsulting.com>
To: Robert Anderson <robander@us.ibm.com>
Date: 09/18/2018 08:15 AM
Subject: PowerPoint deck for GitHub and SourceTree training





--
Best,
Kris

Kristen James Eberlein
Chair, OASIS DITA Technical Committee
Principal consultant, Eberlein Consulting
www.eberleinconsulting.com
+1 919 622-1501; kriseberlein (skype)

[attachment "using-sourcetree-and-github-for-dita-tc-work-REV.pptx" deleted by Robert D Anderson/Rochester/IBM]





[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]