Skip to content

Commit d503d82

Browse files
committed
Add trailing period based on feedback
1 parent 9b209c5 commit d503d82

File tree

1 file changed

+76
-76
lines changed

1 file changed

+76
-76
lines changed

docs/terms-policies/governance.md

Lines changed: 76 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -61,41 +61,41 @@ The DANDI Project codebase includes the components listed in the table below. Mu
6161
Anyone submitting issues, pull requests, documentation, or feedback.
6262

6363
Responsibilities:
64-
- Follow [Code of Conduct](https://github.com/dandi/dandi-archive/blob/master/CODE_OF_CONDUCT.md) and contribution guidelines
65-
- Strive to provide sufficient context and steps to reproduce
66-
- Where applicable, write tests and documentation for code changes
64+
- Follow [Code of Conduct](https://github.com/dandi/dandi-archive/blob/master/CODE_OF_CONDUCT.md) and contribution guidelines.
65+
- Strive to provide sufficient context and steps to reproduce.
66+
- Where applicable, write tests and documentation for code changes.
6767

6868
### 5.2 Reviewers
6969
Contributors granted reviewer status for designated repositories.
7070

7171
Responsibilities:
72-
- Perform timely, constructive reviews
73-
- Enforce style, testing, and security practices
74-
- Identify architectural and performance impacts
72+
- Perform timely, constructive reviews.
73+
- Enforce style, testing, and security practices.
74+
- Identify architectural and performance impacts.
7575

7676
Path to role:
77-
- Consistent high‑quality reviews
78-
- Sponsored by at least one Maintainer
77+
- Consistent high‑quality reviews.
78+
- Sponsored by at least one Maintainer.
7979

8080
### 5.3 Maintainers
8181
Individuals with merge rights for designated repositories.
8282

8383
Responsibilities:
84-
- Merge approval
85-
- Release planning and tagging
86-
- Triage (labels, prioritization, assignment)
87-
- Manage vulnerability reports
88-
- Escalate policy or security concerns
89-
- Facilitate cross‑repository alignment
90-
- Onboard and mentor reviewers
84+
- Merge approval.
85+
- Release planning and tagging.
86+
- Triage (labels, prioritization, assignment).
87+
- Manage vulnerability reports.
88+
- Escalate policy or security concerns.
89+
- Facilitate cross‑repository alignment.
90+
- Onboard and mentor reviewers.
9191

9292
Expectations:
93-
- Active presence
94-
- Adhere to conflict of interest and bias avoidance
93+
- Active presence.
94+
- Adhere to conflict of interest and bias avoidance.
9595

9696
Path to role:
97-
- Demonstrated sustained contributions and review quality
98-
- Nomination and consensus of existing repository Maintainers
97+
- Demonstrated sustained contributions and review quality.
98+
- Nomination and consensus of existing repository Maintainers.
9999

100100
Maintainers for the respective DANDI repositories:
101101
| Repository | Maintainers |
@@ -118,11 +118,11 @@ Maintainers for the respective DANDI repositories:
118118
- [Yaroslav O. Halchenko](https://centerforopenneuroscience.org/whoweare) ([@yarikoptic](https://github.com/yarikoptic))
119119

120120
- Responsibilities:
121-
- Approve or amend governance document and Code of Conduct
122-
- Strategic project oversight
123-
- Resolve escalated disputes
124-
- Approve major architectural shifts
125-
- Oversee risk, sustainability, funding alignment
121+
- Approve or amend governance document and Code of Conduct.
122+
- Strategic project oversight.
123+
- Resolve escalated disputes.
124+
- Approve major architectural shifts.
125+
- Oversee risk, sustainability, funding alignment.
126126

127127
## 6. Decision-Making Model
128128

@@ -146,108 +146,108 @@ Maintainers for the respective DANDI repositories:
146146
## 7. Pull Request Workflow
147147

148148
### 7.1 Pull Request Requirements
149-
- Link the associated issue
150-
- Add a clear description (problem, approach, alternatives considered)
151-
- Major architectural changes require a design document
152-
- Add or update tests
153-
- Update documentation
154-
- Ensure CI passes
155-
- Large pull requests should be split unless justified
156-
- No introduction of unreviewed secrets or credentials
157-
- Verified provenance for large binary additions (discouraged in code repos)
149+
- Link the associated issue.
150+
- Add a clear description (problem, approach, alternatives considered).
151+
- Major architectural changes require a design document.
152+
- Add or update tests.
153+
- Update documentation.
154+
- Ensure CI passes.
155+
- Large pull requests should be split unless justified.
156+
- No introduction of unreviewed secrets or credentials.
157+
- Verified provenance for large binary additions (discouraged in code repos).
158158

159159
### 7.2 Merge Policy
160160
- All pull requests require:
161-
- All comments must be resolved or addressed
162-
- If a comment cannot be resolved, the Project Leadership would be enlisted to decide on the path forward
163-
- Approval by at least 1 listed Maintainer for that repository
164-
- 24 hour waiting period (unless addressing a critical issue)
165-
- See section below regarding updates to the Governance document
161+
- All comments must be resolved or addressed.
162+
- If a comment cannot be resolved, the Project Leadership would be enlisted to decide on the path forward.
163+
- Approval by at least 1 listed Maintainer for that repository.
164+
- 24 hour waiting period (unless addressing a critical issue).
165+
- See section below regarding updates to the Governance document.
166166

167167
### 7.3 Draft vs Ready for Review
168-
- Open as a Draft for early feedback
169-
- Convert to “Ready” only when tests and documentation are updated
168+
- Open as a Draft for early feedback.
169+
- Convert to “Ready” only when tests and documentation are updated.
170170

171171
### 7.4 Reverts
172172
- Any Maintainer may revert a merged pull request causing regression, security issue, or service degradation, with immediate notice in original pull request thread.
173173
- All changes (including reverts) must be submitted through a pull request, and a new release must be made if the prior change was already released.
174-
- Follow-up issue required to track remediation
174+
- Follow-up issue required to track remediation.
175175

176176
## 8. Releases
177177

178178
### 8.1 Versioning
179-
- [Semantic Versioning 2.0](https://semver.org/spec/v2.0.0.html) for APIs and libraries
179+
- [Semantic Versioning 2.0](https://semver.org/spec/v2.0.0.html) for APIs and libraries.
180180

181181
### 8.2 Release Steps
182182
- For [dandi-archive](https://github.com/dandi/dandi-archive), once a pull request is merged the changes are deployed to the sandbox environment (https://sandbox.dandiarchive.org) for review and testing prior to release.
183183
- New releases are created with a GitHub Actions workflow built around [`auto`](https://github.com/intuit/auto).
184184
- When a pull request is merged that has the "`release`" label, `auto`:
185-
- Updates the changelog based on the pull requests since the last release and commits the results
186-
- Tags the new commit with the next version number
187-
- Creates a GitHub release for the tag
188-
- For [dandi-cli](https://github.com/dandi/dandi-cli), upon release a new version is published to PyPI
185+
- Updates the changelog based on the pull requests since the last release and commits the results.
186+
- Tags the new commit with the next version number.
187+
- Creates a GitHub release for the tag.
188+
- For [dandi-cli](https://github.com/dandi/dandi-cli), upon release a new version is published to PyPI.
189189

190190
## 9. Security
191191

192192
### 9.1 Reporting
193-
- Security reports via [email protected]
194-
- Acknowledge within 48 hours
193+
- Security reports via [email protected].
194+
- Acknowledge within 48 hours.
195195

196196
### 9.2 Handling
197-
- Initial assessment within 5 business days
198-
- Coordinate and address issue within 30 days
199-
- User advisory via email when appropriate
197+
- Initial assessment within 5 business days.
198+
- Coordinate and address issue within 30 days.
199+
- User advisory via email when appropriate.
200200

201201
### 9.3 Hardening Practices
202-
- Mandatory dependency scanning
203-
- Principle of least privilege enforced for service accounts
202+
- Mandatory dependency scanning.
203+
- Principle of least privilege enforced for service accounts.
204204

205205
## 10. Documentation
206206

207-
- User and developer documentation is available at https://docs.dandiarchive.org
208-
- Design documents for major decisions are available at https://github.com/dandi/dandi-archive/tree/master/doc
209-
- DEVELOPMENT.md and CODE_OF_CONDUCT.md are maintained in relevant repositories
207+
- User and developer documentation is available at https://docs.dandiarchive.org.
208+
- Design documents for major decisions are available at https://github.com/dandi/dandi-archive/tree/master/doc.
209+
- DEVELOPMENT.md and CODE_OF_CONDUCT.md are maintained in relevant repositories.
210210

211211
## 11. Communication
212212

213213
Communication channels include:
214214

215-
- GitHub Issues and Discussions for user support and team discussions
216-
- https://github.com/dandi/helpdesk for generic support requests and questions
217-
- individual repositories for targeted discussions
218-
- Slack for user support and team discussions
219-
- Email ([email protected], [email protected]) for user support
220-
- Email announcements for critical notifications to users
221-
- GitHub Releases for release announcements
222-
- Email newsletter to highlight major changes
215+
- GitHub Issues and Discussions for user support and team discussions.
216+
- https://github.com/dandi/helpdesk for generic support requests and questions.
217+
- individual repositories for targeted discussions.
218+
- Slack for user support and team discussions.
219+
- Email ([email protected], [email protected]) for user support.
220+
- Email announcements for critical notifications to users.
221+
- GitHub Releases for release announcements.
222+
- Email newsletter to highlight major changes.
223223

224224
## 12. Community
225225

226-
- Outreach events are hosted in collaboration with the Neurodata Without Borders team and can be found at https://nwb.org/events
226+
- Outreach events are hosted in collaboration with the Neurodata Without Borders team and can be found at https://nwb.org/events.
227227
- Code of Conduct is available at https://github.com/dandi/dandi-archive/blob/master/CODE_OF_CONDUCT.md
228-
- Instances of Code of Conduct violation can be reported to [email protected]
229-
- Enforcement of Code of Conduct is separate from primary technical decision flow where possible
228+
- Instances of Code of Conduct violation can be reported to [email protected].
229+
- Enforcement of Code of Conduct is separate from primary technical decision flow where possible.
230230

231231
## 13. Amendments to Project Governance
232232

233233
Process
234234

235-
1. Proposal pull request
236-
2. Minimum of a 30 day public comment
237-
3. Approval by Project Leadership
238-
4. Update version and effective data in Governance document header
235+
1. Proposal pull request.
236+
2. Minimum of a 30 day public comment.
237+
3. Approval by Project Leadership.
238+
4. Update version and effective data in Governance document header.
239239

240240
- Urgent amendments may use an accelerated 7 day window with rationale documented.
241241
- The document becomes active upon Project Leadership approval and publication in the [DANDI Docs](https://docs.dandiarchive.org/).
242242

243243
## 14. Sunset Policy
244244

245245
If a component becomes unmaintained:
246-
- Create a plan with guidance from the Project Leadership
247-
- Update documentation to reflect deprecation including migration guidance
248-
- Mark repository with `ARCHIVED` notice
246+
- Create a plan with guidance from the Project Leadership.
247+
- Update documentation to reflect deprecation including migration guidance.
248+
- Mark repository with `ARCHIVED` notice.
249249

250250
## 15. Licenses
251251

252-
- Licenses (for code, artwork, documentation) are declared per repository
253-
- Licenses must be [DFSG](https://www.debian.org/social_contract#guidelines) and [OSI](https://opensource.org/licenses) compliant
252+
- Licenses (for code, artwork, documentation) are declared per repository.
253+
- Licenses must be [DFSG](https://www.debian.org/social_contract#guidelines) and [OSI](https://opensource.org/licenses) compliant.

0 commit comments

Comments
 (0)