Skip to content

Maintainer Documentation

Jump to bottom Edit New page
f-schmitt-zih edited this page May 28, 2014 · 30 revisions

You are here: Home > Maintainer Documentation

Welcome to the PIConGPU Maintainer section of our wiki! We collect administrative tasks and policies here.

General Topics and To Do's

  • How to "Code Review": See the Code Review guide
  • Compile Suite Documentation
  • Policies for acknowledgements and co-authors in PIConGPU releated publications

How to Draft a new Release

how to collect & write the change log

  • create a release branch from dev: git checkout -b release-<to-be-tag-name>
  • get all logs from git log --oneline --graph --decorate --first-parent in dev
  • read the issues related to it and group bugs/features/misc
  • now compare the changes in .param and .unitless files again, make sure they are highlighted in the change log: cd src/picongpu/include/simulation_defines/ ; git diff master.. .
  • find related issues with git blame <pathToParam-File> - use the commits sha to search for the issue on GitHub (use the top row search bar) or via git log <sha> todo: write a script that finds the associated pulls itself
  • commit the change log
  • publish the release branch and "wait" for further bug fixes only
  • start a pull request to master (ideally, this should be a fast-forward)
  • tag the new commit in master (see below)
  • sync back the change log and version changes to dev with a new pull request from master

port the pre-release wiki changes

Port the wiki changes from the Pre-Release-Content pages in the wiki. Remember to fix the title, i.e. remove any PR: prefix.

version names

to do

back porting bug fixes

All wiki entries describe the dev branch. Features may be different in the current master branch.

Before you start please read our README!

PIConGPU is a scientific project. If you present and/or publish scientific results that used PIConGPU, you should set a reference to show your support. Our according up-to-date publication at the time of your publication should be inquired from:

The documentation in this wiki is still not complete and we need your help keeping it up to date. Feel free to help improving this wiki!

Add a custom sidebar
Clone this wiki locally