Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update CONTRIBUTING.md #1207

Closed
wants to merge 2 commits into from
+212,729 −43,460
Closed

Update CONTRIBUTING.md #1207

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6849321
Update CONTRIBUTING.md
dbirman Jan 3, 2025
15b4676
bump schema version [skip actions]
github-actions[bot] Jan 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,4 +102,15 @@ where scope (optional) describes the packages affected by the code changes and t
- **test**: Adding missing tests or correcting existing tests
to set up your environment.

When you are ready to open a pull request, please link any relevant issues and request a review. Thanks for contributing!
When you are ready to open a pull request, please link any relevant issues and request a review. Thanks for contributing!

## Release

- From dev, create a branch called release-vX.Y.Z
- Manually increment the version number in the aind_data_schema/__init__.py file to match
- Manually increment the major/minor/patch versions of the core files as needed
- Push the branch and open a PR into main
- After this push, any last minute changes to the release-vX.Y.Z will have to done to via a PR
- After review, use a merge commit to merge into main
- Open a PR from main back into dev so they're synced again
- Create a Github release with the corresponding tag, modify the auto-generated release notes to focus on the major changes that occurred.
2 changes: 1 addition & 1 deletion examples/aibs_smartspim_instrument.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"describedBy": "https://raw.githubusercontent.com/AllenNeuralDynamics/aind-data-schema/main/src/aind_data_schema/core/instrument.py",
"schema_version": "1.0.3",
"schema_version": "1.0.4",
"instrument_id": "440_SmartSPIM2_20231004",
"modification_date": "2023-10-04",
"instrument_type": "SmartSPIM",
Expand Down
2 changes: 1 addition & 1 deletion examples/aibs_smartspim_procedures.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"describedBy": "https://raw.githubusercontent.com/AllenNeuralDynamics/aind-data-schema/main/src/aind_data_schema/core/procedures.py",
"schema_version": "1.1.3",
"schema_version": "1.1.4",
"subject_id": "651286",
"subject_procedures": [
{
Expand Down
2 changes: 1 addition & 1 deletion examples/aind_smartspim_instrument.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"describedBy": "https://raw.githubusercontent.com/AllenNeuralDynamics/aind-data-schema/main/src/aind_data_schema/core/instrument.py",
"schema_version": "1.0.3",
"schema_version": "1.0.4",
"instrument_id": "440_SmartSPIM1_20231004",
"modification_date": "2023-10-04",
"instrument_type": "SmartSPIM",
Expand Down
2 changes: 1 addition & 1 deletion examples/bergamo_ophys_session.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"describedBy": "https://raw.githubusercontent.com/AllenNeuralDynamics/aind-data-schema/main/src/aind_data_schema/core/session.py",
"schema_version": "1.0.3",
"schema_version": "1.0.4",
"protocol_id": [],
"experimenter_full_name": [
"John Doe"
Expand Down
2 changes: 1 addition & 1 deletion examples/data_description.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"describedBy": "https://raw.githubusercontent.com/AllenNeuralDynamics/aind-data-schema/main/src/aind_data_schema/core/data_description.py",
"schema_version": "1.0.3",
"schema_version": "1.0.4",
"license": "CC-BY-4.0",
"platform": {
"name": "Electrophysiology platform",
Expand Down
2 changes: 1 addition & 1 deletion examples/ephys_rig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"describedBy": "https://raw.githubusercontent.com/AllenNeuralDynamics/aind-data-schema/main/src/aind_data_schema/core/rig.py",
"schema_version": "1.0.3",
"schema_version": "1.0.4",
"rig_id": "323_EPHYS1_20231003",
"modification_date": "2023-10-03",
"mouse_platform": {
Expand Down
2 changes: 1 addition & 1 deletion examples/ephys_session.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"describedBy": "https://raw.githubusercontent.com/AllenNeuralDynamics/aind-data-schema/main/src/aind_data_schema/core/session.py",
"schema_version": "1.0.3",
"schema_version": "1.0.4",
"protocol_id": [],
"experimenter_full_name": [
"Max Quibble",
Expand Down
2 changes: 1 addition & 1 deletion examples/exaspim_acquisition.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"describedBy": "https://raw.githubusercontent.com/AllenNeuralDynamics/aind-data-schema/main/src/aind_data_schema/core/acquisition.py",
"schema_version": "1.0.3",
"schema_version": "1.0.4",
"protocol_id": [],
"experimenter_full_name": [
"###"
Expand Down
2 changes: 1 addition & 1 deletion examples/exaspim_instrument.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"describedBy": "https://raw.githubusercontent.com/AllenNeuralDynamics/aind-data-schema/main/src/aind_data_schema/core/instrument.py",
"schema_version": "1.0.3",
"schema_version": "1.0.4",
"instrument_id": "440_exaSPIM1-20231004",
"modification_date": "2023-10-04",
"instrument_type": "exaSPIM",
Expand Down
2 changes: 1 addition & 1 deletion examples/fip_behavior_rig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"describedBy": "https://raw.githubusercontent.com/AllenNeuralDynamics/aind-data-schema/main/src/aind_data_schema/core/rig.py",
"schema_version": "1.0.3",
"schema_version": "1.0.4",
"rig_id": "447_FIP-Behavior_20000101",
"modification_date": "2000-01-01",
"mouse_platform": {
Expand Down
2 changes: 1 addition & 1 deletion examples/fip_ophys_rig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"describedBy": "https://raw.githubusercontent.com/AllenNeuralDynamics/aind-data-schema/main/src/aind_data_schema/core/rig.py",
"schema_version": "1.0.3",
"schema_version": "1.0.4",
"rig_id": "428_FIP1_20231003",
"modification_date": "2023-10-03",
"mouse_platform": {
Expand Down
2 changes: 1 addition & 1 deletion examples/mri_session.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"describedBy": "https://raw.githubusercontent.com/AllenNeuralDynamics/aind-data-schema/main/src/aind_data_schema/core/session.py",
"schema_version": "1.0.3",
"schema_version": "1.0.4",
"protocol_id": [
"dx.doi.org/10.57824/protocols.io.bh7kl4n6"
],
Expand Down
2 changes: 1 addition & 1 deletion examples/multiplane_ophys_session.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"describedBy": "https://raw.githubusercontent.com/AllenNeuralDynamics/aind-data-schema/main/src/aind_data_schema/core/session.py",
"schema_version": "1.0.3",
"schema_version": "1.0.4",
"protocol_id": [],
"experimenter_full_name": [
"John Doe"
Expand Down
2 changes: 1 addition & 1 deletion examples/ophys_procedures.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"describedBy": "https://raw.githubusercontent.com/AllenNeuralDynamics/aind-data-schema/main/src/aind_data_schema/core/procedures.py",
"schema_version": "1.1.3",
"schema_version": "1.1.4",
"subject_id": "625100",
"subject_procedures": [
{
Expand Down
2 changes: 1 addition & 1 deletion examples/ophys_session.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"describedBy": "https://raw.githubusercontent.com/AllenNeuralDynamics/aind-data-schema/main/src/aind_data_schema/core/session.py",
"schema_version": "1.0.3",
"schema_version": "1.0.4",
"protocol_id": [],
"experimenter_full_name": [
"John Doe"
Expand Down
2 changes: 1 addition & 1 deletion examples/procedures.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"describedBy": "https://raw.githubusercontent.com/AllenNeuralDynamics/aind-data-schema/main/src/aind_data_schema/core/procedures.py",
"schema_version": "1.1.3",
"schema_version": "1.1.4",
"subject_id": "625100",
"subject_procedures": [
{
Expand Down
2 changes: 1 addition & 1 deletion examples/processing.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"describedBy": "https://raw.githubusercontent.com/AllenNeuralDynamics/aind-data-schema/main/src/aind_data_schema/core/processing.py",
"schema_version": "1.1.3",
"schema_version": "1.1.4",
"processing_pipeline": {
"data_processes": [
{
Expand Down
2 changes: 1 addition & 1 deletion examples/quality_control.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"describedBy": "https://raw.githubusercontent.com/AllenNeuralDynamics/aind-data-schema/main/src/aind_data_schema/core/quality_control.py",
"schema_version": "1.2.1",
"schema_version": "1.2.2",
"evaluations": [
{
"modality": {
Expand Down
2 changes: 1 addition & 1 deletion examples/subject.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"describedBy": "https://raw.githubusercontent.com/AllenNeuralDynamics/aind-data-schema/main/src/aind_data_schema/core/subject.py",
"schema_version": "1.0.2",
"schema_version": "1.0.3",
"subject_id": "12345",
"sex": "Male",
"date_of_birth": "2022-11-22",
Expand Down
Loading