Maintainer Documentation

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
• Labels for pull requests and issues
• Compile Suite Documentation
• Policies for acknowledgements and co-authors in PIConGPU releated publications

How to Draft a new Release

update version names/numbers

• PIConGPU: src/picongpu/include/version.hpp

see semver.org

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 and sign this tag (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.

back porting bug fixes

• minimal changes (no API/.param changes)
• create a revision for 1 to N combined fixes (the Z in the X.Y.Z version number)