Describes how to contribute code to the NetarchiveSuite git repository on Github.

Code can be added to the NetarchiveSuite repository in two ways, either by pushing directly to the repository or by creating pull requests from a forked repository. 

Committing directly to the NetarchiveSuite repository

This is used for core developers to add code in the NetarchiveSuite platform and requires the contributor to have commit permissions on the NetarchiveSuite project. The includes the DK NetarchiveSuite developers.


Inspired by the Git-flow branch model we aim to develop all nontrivial code changes on feature branches with merges to master after a feature has been finished. The workflow here is:

  1. Start the development on a feature by creating a new local feature branch. The standard is to name this according to the related JIRA issue.

    git checkout -b NAS-XXXX master
  2. Do the development with frequent commits of our code changes. The commit message should be of the format: 

    NAS-XXXX: ${short description}
    NAS-XXXX ${issue summary}: ${long description}

    Only the first line is mandatory and should be no longer than 50. Following lines should be no longer that 72 chars log. 

  3. Prepare for merge to master by:
  4. Merge to master
  5. Finally push the new feature code to Github master: 

    git push

All done (smile).

Removing branches

Branches may be removed after the development of a feature has finishes.

An effort should also be made at the end of a development cycle/release to clean out old branches.

Contributing patches through pull requests

Used mainly by developers wishing to contribute code occasionally to the NetarchiveSuite repo.

Please see Github documentation on how do this.