This tutorial wil guide you step to step from an empty directory to a new feature being proposed in the official GitHub repository. For more general questions please have a look at the FAQ pages.
Please make sure you registered to GitHub and that you have provided them a ssh public key to access your private repository. For more information see the FAQ.
Set up the work area just like you used to.
> scram project CMSSW_8_0_1 > cd CMSSW_8_0_1/src > cmsenv
git cms-addpkg behaves like the old addpkg.
The src directory is populated with just what we asked for (here
> git cms-addpkg DataFormats/TestObjects > ls DataFormats/TestObjects BuildFile.xml
By default it would simply use the current release tag (e.g.
CMSSW_8_0_1). At any point you can list the available branches via
> git branch * from-CMSSW_8_0_1
* next to the branch name will tell you which one is the current one.
The name of the branch is meant to show you the tag which was used as a base
for the branch.
In order to simplify your workflow, the best thing to do is to branch immediately and assign a mnemonic name to your newly created branch, so that you can track what you were doing in an easier way.
> git checkout -b my-new-feature Switched to a new branch 'my-new-feature'
For example you could call your branch “new-hlt-menu-XYZ”,
“bugfix-for-clustering”, etc. Compared to CVS,
git checkout <branch> means
branch the current
branch in the local work area”.
-b option is needed to create the branch if it does not exists.
> cd DataFormats/TestObjects > nedit BuildFile.xml > git commit -m "Test feature" BuildFile.xml [my-new-feature 8135042] Test feature 1 file changed, 1 insertion(+)
You have just committed to your LOCAL copy of the repository.
Git supports multiple remote repository. In particular we will use:
To show what remotes are available you can use
git remote show:
> git remote show my-cmssw official-cmssw
The general workflow for development will be the following:
Approval information will be populated shortly after you submit the pull request .
Your private repository can be found at:
If you have not set it up yet, do so now by clicking here. You can publish branches to it by doing:
> git push my-cmssw <branch-name>
in this case:
> git push my-cmssw my-new-feature
You need to PUSH YOUR changes to make them available to others in your
private repository. Notice you only need to specify the name of the branch once
then git will remember about it and you can push your new developments by
git push my-cmssw.
A pull request is a request to merge a given addition in your local repository to a branch in the official CMSSW repository. Think of it as publishing a tagset in Tag Collector. To start one click on the “Pull request” button which find on your personal repository.
The GUI for doing “Pull requests” looks like below:
If you click on the “Edit” button in the top right corner, you can select the “head branch” i.e. your addition on to of the official CMSSW.
Or change the “base branch”, i.e. the one to which you want to have your changes merged. Starting from CMSSW_9_1_X and later the base branch for the latest development release is the master branch.
Remember to write a sensible comment, check that gitHubs summary of your changes are as expected, and click on Send Pull Request. There are several issues to consider before clicking