Skip to content

Commit

Permalink
Contributing section in README
Browse files Browse the repository at this point in the history
  • Loading branch information
k1o0 committed Nov 23, 2024
1 parent 8f10ce9 commit d694a70
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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" ]
Expand Down

0 comments on commit d694a70

Please sign in to comment.