documentation: mention module whitelist and add PR templates. (#426)

.github/PULL_REQUEST_TEMPLATE/new_package.md

@@ -0,0 +1,19 @@
+---
+name: Deploy a new package/module
+about: Deploy a new package as a module on BB5
+
+---
+
+# Checklist for new modules
+
+For software developped by BBP:
+
+* [ ] `package@version` has been added into `deploy/packages/bbp-packages.yaml`
+* [ ] `package` has been whitelisted in `deploy/configs/applications/modules.yaml`
+
+Otherwise, adjust the mentioned directories accordingly.
+
+_Note:_ PRs can be tested on BB5:
+
+ $ . /gpfs/bbp.cscs.ch/apps/hpc/jenkins/pulls/<MY_PULL_REQUEST>/config/modules.sh
+ $ module load my_new_module

.github/PULL_REQUEST_TEMPLATE/updated_package.md

@@ -0,0 +1,10 @@
+---
+name: Update a package/module
+about: Update the deployment of a package as a module on BB5
+
+---
+
+_Note:_ PRs can be tested on BB5:
+
+ $ . /gpfs/bbp.cscs.ch/apps/hpc/jenkins/pulls/<MY_PULL_REQUEST>/config/modules.sh
+ $ module load my_updated_module

README.md

@@ -185,6 +185,16 @@ deployment chain (all found in `spack/deploy/packages`):
 * `external-libraries` for packages that are seldomly changed and for which
  the dependency graph may be truncated by Spack (e.g., Spark, Python) - mainly dependencies for building
 
+To actually enable the generation of corresponding module files, new
+software has to be whitelisted in the module configuration for spack, e.g.
+by editing:
+
+ $ vim spack/deploy/configs/applications/modules.yaml
+
+Look for a key `whitelist`, and add the package. Packages listed in the
+module whitelist should be as generic as possible, i.e., not tied to
+specific versions.
+
 Commit the changes and file a pull request on Github.
 Jenkins will build the additional software required, with all output
 available in a separate directory: