LISTSERV mailing list manager LISTSERV 16.5

Help for HPS-SOFTWARE Archives


HPS-SOFTWARE Archives

HPS-SOFTWARE Archives


HPS-SOFTWARE@LISTSERV.SLAC.STANFORD.EDU


View:

Message:

[

First

|

Previous

|

Next

|

Last

]

By Topic:

[

First

|

Previous

|

Next

|

Last

]

By Author:

[

First

|

Previous

|

Next

|

Last

]

Font:

Proportional Font

LISTSERV Archives

LISTSERV Archives

HPS-SOFTWARE Home

HPS-SOFTWARE Home

HPS-SOFTWARE  January 2017

HPS-SOFTWARE January 2017

Subject:

making a PR in hps-java

From:

"McCormick, Jeremy I." <[log in to unmask]>

Reply-To:

Software for the Heavy Photon Search Experiment <[log in to unmask]>

Date:

Thu, 26 Jan 2017 02:56:28 +0000

Content-Type:

text/plain

Parts/Attachments:

Parts/Attachments

text/plain (92 lines)

Hi,

Here is the full procedure for making a PR in hps-java, including how you should structure your development workflow:

(Anything below with a "$" in front means you can execute the command in your shell.)

1) Create a github issue describing the changes you plan on making.

https://github.com/JeffersonLab/hps-java/issues/new

Assign the issue to yourself and give it the "Enhancement" tag for new functionality or "Bug" if you are fixing some problem.

Set the Milestone to "v4.0" which will be the next release.

2) Create a local development branch in hps-java from an up-to-date copy of the master.

$ cd hps-java; git checkout master; git pull; git checkout -b iss1234

The '1234' here is replaced by the actual issue number assigned automatically by the issue tracker.  (You can see this on the webpage for the issue you created in step #1.)

3) Add files to commit that you have changed or added on this branch (obviously the file names I use below are bogus).

$ git add someNewFile aFileIChanged

4) Commit the changes to these files.

$ git commit -m "I changed some stuff and this is my detailed commit message."

These files are now "staged" which means they will be sent to github next time you push.

5) Push your local branch to the github repo.

$ git push -u origin iss1234

Probably you will have to type your github username and password here, unless you have your SSH keys setup properly.

This will create the remote 'iss1234' branch which your local copy will now track, meaning that if someone else also pushes to this branch (like your PR reviewer), you can 'git pull' to get these updates.

6) Now you are ready to open a PR for your changes.

https://github.com/JeffersonLab/hps-java/compare

In the second dropdown box that says "compare: master" select your development branch (e.g. iss1234 in this example).

Click the "Create pull request" button.

Give the PR a description and provide detailed information on what you changed.

Select an appropriate reviewer by clicking on the gear icon next to "Reviewers".  

For now, you can assign all PR to me (username JeremyMcCormick), and I'll change it if I think someone else should do it.

Then click "Create pull request" again.

7) You should have a new PR now that is visible on github in the PR list (empty right now).

https://github.com/JeffersonLab/hps-java/pulls

8) You now need to wait for your code to be reviewed (and possibly tested depending on what was changed).

The reviewer will provide feedback on changes they want to see before the request is merged.

9) Make changes requested by the reviewer using the typical 'git add', 'git commit' and 'git push' commands from your branch.

10) Once changes have been made to their satisfaction, the reviewer will approve the PR and your branch will be merged into master.

Now the master will have your changes so you can pull them into your local copy.

$ git checkout master; git pull

11) You can also delete the local and remote branches if you are done with them...

Delete the local branch:

$ git branch -d iss1234

Delete the remote branch:

$ git push origin --delete iss1234

This seems more complicated than it is -- I have just explicitly listed all the possible steps here so everyone is clear about how it works.

Please let me know if you have questions/comments.

--Jeremy

########################################################################
Use REPLY-ALL to reply to list

To unsubscribe from the HPS-SOFTWARE list, click the following link:
https://listserv.slac.stanford.edu/cgi-bin/wa?SUBED1=HPS-SOFTWARE&A=1

Top of Message | Previous Page | Permalink

Advanced Options


Options

Log In

Log In

Get Password

Get Password


Search Archives

Search Archives


Subscribe or Unsubscribe

Subscribe or Unsubscribe


Archives

June 2024
May 2024
April 2024
March 2024
February 2024
January 2024
December 2023
November 2023
October 2023
September 2023
August 2023
July 2023
June 2023
May 2023
April 2023
March 2023
February 2023
January 2023
December 2022
November 2022
October 2022
September 2022
August 2022
June 2022
April 2022
March 2022
February 2022
January 2022
December 2021
November 2021
October 2021
September 2021
August 2021
July 2021
June 2021
May 2021
April 2021
March 2021
February 2021
January 2021
December 2020
November 2020
October 2020
September 2020
August 2020
July 2020
June 2020
May 2020
April 2020
March 2020
February 2020
January 2020
December 2019
November 2019
October 2019
September 2019
August 2019
July 2019
June 2019
May 2019
April 2019
March 2019
February 2019
January 2019
December 2018
November 2018
October 2018
September 2018
August 2018
July 2018
June 2018
May 2018
April 2018
March 2018
February 2018
January 2018
December 2017
November 2017
October 2017
September 2017
August 2017
July 2017
June 2017
May 2017
April 2017
March 2017
February 2017
January 2017
December 2016
November 2016
October 2016
September 2016
August 2016
July 2016
June 2016
May 2016
April 2016
March 2016
February 2016
January 2016
December 2015
November 2015
October 2015
September 2015
August 2015
July 2015
June 2015
May 2015
April 2015
March 2015
February 2015
January 2015
December 2014
November 2014
October 2014
September 2014
August 2014
July 2014
June 2014
May 2014
April 2014
March 2014
February 2014
January 2014
December 2013
November 2013
October 2013
September 2013
August 2013
July 2013
June 2013
May 2013
April 2013
March 2013
February 2013
January 2013
December 2012
November 2012
October 2012
September 2012
August 2012
July 2012
June 2012
May 2012
April 2012
March 2012
February 2012
January 2012
December 2011
November 2011
October 2011
September 2011
August 2011
July 2011
June 2011
May 2011
April 2011
March 2011

ATOM RSS1 RSS2



LISTSERV.SLAC.STANFORD.EDU

Secured by F-Secure Anti-Virus CataList Email List Search Powered by the LISTSERV Email List Manager

Privacy Notice, Security Notice and Terms of Use