-
Notifications
You must be signed in to change notification settings - Fork 17
Add DANDI governance document #204
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.
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
base: master
Are you sure you want to change the base?
Conversation
Co-authored-by: Yaroslav Halchenko <debian@onerussian.com>
Co-authored-by: Yaroslav Halchenko <debian@onerussian.com>
Co-authored-by: Yaroslav Halchenko <debian@onerussian.com>
Co-authored-by: Yaroslav Halchenko <debian@onerussian.com>
Co-authored-by: Yaroslav Halchenko <debian@onerussian.com>
|
||
## 7. Pull Request Workflow | ||
|
||
### 7.1 Pull Request Requirements |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Given that it takes 30 days minimum to properly amend this doc, IMO we should move pull request requirements, draft-pr policy and possibly release process into the developers guide.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@asmacdo That's fair but I kept this here because we have had discussions on who should merge, when merges should happen, etc. so I think that all aspects of pull requests should be discussed here.
Co-authored-by: Yaroslav Halchenko <debian@onerussian.com>
Hi @satra @waxlamp @jjnesbitt @mvandenburgh @candleindark @bendichter @djarecka, could you please take a look at this doc when you get a chance. Thanks. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
a nearly complete pass
- A cloud-based platform to store, process, and disseminate data. You can use DANDI to collaborate and publish datasets. | ||
- Open access to data to enable secondary uses of data outside the intent of the study. | ||
- Optimize data storage and access through partnerships, compression and accessibility technologies. | ||
- Enables reproducible practices and publications through data standards such as NWB and BIDS. | ||
- The platform is not just an endpoint to dump data, it is intended as a living repository that enables collaboration within and across labs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Opening is "DANDI provides:" so IMHO all items should be continuations to such an opening, thus:
- A cloud-based platform to store, process, and disseminate data. You can use DANDI to collaborate and publish datasets. | |
- Open access to data to enable secondary uses of data outside the intent of the study. | |
- Optimize data storage and access through partnerships, compression and accessibility technologies. | |
- Enables reproducible practices and publications through data standards such as NWB and BIDS. | |
- The platform is not just an endpoint to dump data, it is intended as a living repository that enables collaboration within and across labs. | |
- a cloud-based platform to store, process, and disseminate data. You can use DANDI to collaborate and publish datasets. | |
- open access to data to enable secondary uses of data outside the intent of the study; | |
- optimized data storage and access through partnerships, compression and accessibility technologies; | |
- facilities to encourage reproducible practices and publications through data standards such as NWB and BIDS; | |
- a platform that is not just an endpoint to dump data, but intended to be a living repository that enables collaboration within and across labs. |
or redo opening somehow differently ("DANDI is" ...)
## 3. Core Principles | ||
|
||
1. Openness & Transparency: Designs, discussions, and decisions are public by default | ||
2. FAIR & Reproducibility: Data and code evolution remain traceable and citable |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
2. FAIR & Reproducibility: Data and code evolution remain traceable and citable | |
2. FAIR & Reproducibility: Data and code follow standards and their evolution remain open, traceable, and citable |
since IMHO standards are the core of FAIR
### 5.1 Contributors | ||
Anyone submitting issues, pull requests, documentation, or feedback. | ||
Responsibilities: | ||
- Follow Code of Conduct and contribution guidelines |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
hard to follow if no references! Will they be per project or generic?
Anyone submitting issues, pull requests, documentation, or feedback. | ||
Responsibilities: | ||
- Follow Code of Conduct and contribution guidelines | ||
- Provide context and reproducible steps |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Provide context and reproducible steps | |
- Strive to provide sufficient context and steps to reproduce |
|
||
### 5.2 Reviewers | ||
Contributors granted reviewer status for designated repositories. | ||
Responsibilities: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Responsibilities: | |
Responsibilities: |
Expectations: | ||
- Active presence | ||
- Adhere to conflict of interest and bias avoidance | ||
Path to role: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Path to role: | |
Path to role: |
## 6. Decision-Making Model | ||
|
||
### 6.1 Roadmap | ||
- Project targets are discussed during the biweekly Engineering Core and Scientific Core meetings. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ideally, make trailing .
uniform across listings. Above sections didn't have them, and here they come. Just add them all over
### 7.2 Merge Policy | ||
- All pull requests require: | ||
- All comments must be resolved or addressed | ||
- Approval by at least 1 listed Maintainer for that repository |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"listed" where?
how do we resolve road-blocks? e.g. Project Leadership
could have a decree to approve/disprove?
- All pull requests require: | ||
- All comments must be resolved or addressed | ||
- Approval by at least 1 listed Maintainer for that repository | ||
- 24 hour waiting period (unless addressing a critical issue) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- 24 hour waiting period (unless addressing a critical issue) | |
- 24 hour waiting period (unless addressing a critical issue or obviously trivial) |
? so that some typo in comment could be fixed without waiting/forgetting
- Convert to “Ready” only when tests and documentation are updated | ||
|
||
### 7.4 Reverts | ||
- Any Maintainer may revert a merged pull request causing regression, security issue, or service degradation, with immediate notice in original pull request thread. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"almost", release might not be needed if prior change was not even released yet. so state not "must be made" but "must be made if prior change was already released"?
Effective Date
Status