You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -146,108 +146,108 @@ Maintainers for the respective DANDI repositories:
146
146
## 7. Pull Request Workflow
147
147
148
148
### 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).
158
158
159
159
### 7.2 Merge Policy
160
160
- 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.
166
166
167
167
### 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.
170
170
171
171
### 7.4 Reverts
172
172
- Any Maintainer may revert a merged pull request causing regression, security issue, or service degradation, with immediate notice in original pull request thread.
173
173
- 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.
175
175
176
176
## 8. Releases
177
177
178
178
### 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.
180
180
181
181
### 8.2 Release Steps
182
182
- 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.
183
183
- New releases are created with a GitHub Actions workflow built around [`auto`](https://github.com/intuit/auto).
184
184
- 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.
0 commit comments