Skip to content

Commit d694a70

Browse files
committed
Contributing section in README
1 parent 8f10ce9 commit d694a70

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,12 @@ pip install -e .
1414
- `projects/task_type_procedures.json` - Associate Alyx procedures to a custom task protocol
1515
- `projects/_template.py` - Example for creating a custom Bpod extractor, QC or DAQ sync task
1616
- `projects/extraction_tasks.py` - Where to import pipeline tasks so they are readable by ibllib
17+
18+
## Contributing
19+
20+
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).
21+
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.
22+
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.
23+
24+
> [!IMPORTANT]
25+
> 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.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
44

55
[project]
66
name = "project_extraction"
7-
version = "0.5.0"
7+
version = "0.5.0post0"
88
description = "Custom extractors for satellite tasks"
99
dynamic = [ "readme" ]
1010
keywords = [ "IBL", "neuro-science" ]

0 commit comments

Comments
 (0)