From 434ba9e25435ae8517c5a1d8cb10f0d17657bffa Mon Sep 17 00:00:00 2001 From: Ohisemega Date: Tue, 14 Jul 2026 12:35:23 +0000 Subject: [PATCH 1/3] Add Existing Script to container PostCreateCommand Update the readme with developer instructions. --- .devcontainer/devcontainer.json | 3 ++- README.md | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 35 insertions(+), 1 deletion(-) diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 15dce056b..941602d28 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -49,5 +49,6 @@ "source=/dev/shm,target=/dev/shm,type=bind" ], // After the container is created, install the python project in editable form - "postCreateCommand": "pip install $([ -f dev-requirements.txt ] && echo '-c dev-requirements.txt') -e './python[dev]'" + "postCreateCommand": "pip install $([ -f dev-requirements.txt ] && echo '-c dev-requirements.txt') -e './python[dev]'", + "postStartCommand": "./setup_git.sh" } diff --git a/README.md b/README.md index 1e71ee5d8..2c782812a 100644 --- a/README.md +++ b/README.md @@ -10,3 +10,36 @@ of two communicating applications; the FrameReceiver and FrameProcessor. It acts data capture and processing pipeline for detector data streams transferred over a network connection. The FrameReceiver constructs data frames in shared memory buffers and the FrameProcessor performs processing on the buffer and writes data to disk. + +Notes to Contributors: + +1. To allow sharing of git hooks they have been stored in the directory '.githooks'. +For them to be used you MUST run the following command (only needs to be run once) + +Either: + + Build (or rebuild) the dev-container in VScode, and the hooks are a automatically setup. + +Or: + Run + `git config core.hooksPath .githooks` + If not developing using the dev container. + +2. In order to allow formatting changes (and possibly other things) to be made to the codebase, +without too much disruption to the efficacy of the git-blame the following procedure can +be used. + +There is a file called .git-blame-ignore-revs in the root of the repository that can be +updated to record each commit that should be ignored for git-blame purposes. + +To actually set this up so that it is used by git-blame you need to the run the following +command (it only needs to be run once as the information is then stored in .git/config +for this repository) + +Either: + + Build (or rebuild) the dev-container in VScode, and the tools are a automatically setup. + +Or: + + git config blame.ignoreRevsFile .git-blame-ignore-revs From 3c96aa9c0aa4ccfccc84b525dec42b4ea1d92e8a Mon Sep 17 00:00:00 2001 From: Ohisemega Date: Tue, 14 Jul 2026 13:51:05 +0000 Subject: [PATCH 2/3] Update githook Setup Script Path --- .devcontainer/devcontainer.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 941602d28..c85ca654e 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -50,5 +50,5 @@ ], // After the container is created, install the python project in editable form "postCreateCommand": "pip install $([ -f dev-requirements.txt ] && echo '-c dev-requirements.txt') -e './python[dev]'", - "postStartCommand": "./setup_git.sh" + "postStartCommand": "/workspaces/odin-data/scripts/setup_git.sh" } From 545b3b2089a8535636afdd74fe62eefa0a3a1cb2 Mon Sep 17 00:00:00 2001 From: Ohisemega Date: Thu, 16 Jul 2026 12:15:56 +0000 Subject: [PATCH 3/3] Fix Typo in README --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2c782812a..866b98c17 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ For them to be used you MUST run the following command (only needs to be run onc Either: - Build (or rebuild) the dev-container in VScode, and the hooks are a automatically setup. + Build (or rebuild) the dev-container in VScode, and the hooks are automatically setup. Or: Run @@ -38,7 +38,7 @@ for this repository) Either: - Build (or rebuild) the dev-container in VScode, and the tools are a automatically setup. + Build (or rebuild) the dev-container in VScode, and the tools are automatically setup. Or: