Updated over 8 years ago by Knödlseder Jürgen

Git workflow for GammaLib

Summary

Any contributions to the GammaLib package, whether bug fixes, improvements to the documentation, or new functionality, can be done via pull requests. Pull requests are issued by changing the status of a GammaLib issue to Pull request.

As developer, you have two options for contribution code to the project:

Which of the two to pick is a matter of taste. If you don’t know which to pick, use the irap one.

Getting started with git

The only absolutely necessary configuration step is identifying yourself and your contact info:

$ git config --global user.name "Joe Public" 
$ git config --global user.email "joe.public@gmail.com" 

Please make sure that you specify your full name as user.name, do not use your abbreviated login name because this makes code modification tracking more cryptic.

In case that you get

error: SSL certificate problem, verify that the CA cert is OK.
you may add
$ export GIT_SSL_NO_VERIFY=true
before retrieving the code. Alternatively, you may type
$ git config --global http.sslverify "false" 
which disables certificate verification globally for your Git installation.

The following sections cover the installation of the git software, the basic configuration, and links to resources to learn more about using git. If you use GitHub, you may also check the GitHub help pages which offer a great introduction to git and GitHub.

Using the central GammaLib repository

The following sections describe the configuration and the workflow for the central GammaLib repository.

Using GitHub

The following sections describe the configuration and the workflow for the GitHub GammaLib repository.

Also available in: PDF HTML TXT