From d694a7024e65beeed482e59bc1289c408db3948f Mon Sep 17 00:00:00 2001 From: Miles Wells Date: Sat, 23 Nov 2024 17:24:29 +0200 Subject: [PATCH] Contributing section in README --- README.md | 9 +++++++++ pyproject.toml | 2 +- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5581073..0c383f4 100644 --- a/README.md +++ b/README.md @@ -14,3 +14,12 @@ pip install -e . - `projects/task_type_procedures.json` - Associate Alyx procedures to a custom task protocol - `projects/_template.py` - Example for creating a custom Bpod extractor, QC or DAQ sync task - `projects/extraction_tasks.py` - Where to import pipeline tasks so they are readable by ibllib + +## Contributing + +To contribute to this repository you must create a pull request into main. Before merging you must increase the version number in the [pyproject.toml](./pyproject.toml) file (see [this guide](https://packaging.python.org/en/latest/specifications/version-specifiers/#version-specifiers) for versioning scheme). +A GitHub check will ensure that the repository version is valid and greater than the version on the main branch. This is essential as we currently do not publish to PyPi. +The pull request may be merged only when this check passes. Bypassing this check is not permitted, nor are direct pushes to main. Once merged, a version tag is automatically generated. + +> [!IMPORTANT] +> Tests in this repository are run by both the [iblrig](https://github.com/int-brain-lab/iblrig) and [ibllib](https://github.com/int-brain-lab/ibllib) CI. diff --git a/pyproject.toml b/pyproject.toml index c807436..bff5c3c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" [project] name = "project_extraction" -version = "0.5.0" +version = "0.5.0post0" description = "Custom extractors for satellite tasks" dynamic = [ "readme" ] keywords = [ "IBL", "neuro-science" ]