From b98fed75a61b6647371d59f463fb8849ede1e99f Mon Sep 17 00:00:00 2001
From: Robert Rosca <robert.rosca@xfel.eu>
Date: Mon, 22 Feb 2021 14:11:13 +0100
Subject: [PATCH] Add todos, adjust headings

---
 README.rst | 43 +++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 41 insertions(+), 2 deletions(-)

diff --git a/README.rst b/README.rst
index 9cb0c8b14..2f14a98a2 100644
--- a/README.rst
+++ b/README.rst
@@ -73,11 +73,48 @@ venv) activate the virtual environment first, and then run:
   python3 -m pip install ipykernel  # If not using a venv add `--user` flag
   python3 -m ipykernel install --user --name pcalibration --display-name "pcalibration"  # If not using a venv pick different name
 
-This can be useful for Jupyter notebook tools as "max-jhub.desy.de".
+This can be useful for Jupyter notebook tools as https://max-jhub.desy.de/hub/login
+
+
+Contributing
+************
+
+Code Standards
+==============
+
+... something?
+
+TODO: How should we handle where what information goes? Right now a decent
+amount of stuff is in the wiki, but I think it's a bit nicer to have some of the
+information in the readme as it'll be there and visible when you clone the repo.
+
+Basics
+======
+
+The installation instructions above assume that you have set up SSH keys for use
+with GitLab to allow for passwordless clones from GitLab, this way it's possible
+to run ``pip install git+ssh...`` commands and install packages directly from
+GitLab.
+
+To do this check the settings page here: https://git.xfel.eu/gitlab/profile/keys
+
+Pre-Commit Hooks
+================
+
+This repository uses pre-commit hooks to ensure that a number of checks have
+been made before code is committed and pushed to the...
+
+TODO:
+
+1. List of checks
+2. Mention how the CI only runs on diffs between PR branch and target branch
+3. Include runnable script to have same behaviour as on gitlab
+4. Mention having to rebase for diffs to be correct if merge target changes
+
 
 
 Python Scripted Calibration
-===========================
+***************************
 
 **Do not run this on the Maxwell gateway**. Rather, ``salloc`` a node for
 yourself first:
@@ -95,6 +132,8 @@ not using a venv).
 If running headless (i.e. without X forwarding), be sure to set
 ``MPLBACKEND=Agg``, via:
 
+.. code::
+
   export MPLBACKEND=Agg
 
 Then start an ``ipcluster``. If you followed the steps above this can be done
-- 
GitLab