neurobagel / neurobagel/dev-docs
Create a checklist for milestone implementation speccing
Open
@surchs is already working on this.
Since Mar 27, 2026.
process
someday
usability
- Dominant language
- No language data
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
When we spec a milestone and go from "this is what we want to work after" to "here is how we will make sure it works after", it can be difficult to think about all of the affected aspects of our tools / network. In order to not have to have perfect memory every time, we should
- Start a checklist of questions and concerns to consider during implementation speccing
- Update this checklist as we continue using it so it becomes more useful over time.
Couple of points that could / should live in such a checklist:
- What will be the impact to the network of releasing these changes in our tools?
- Do we expect stragglers / nodes on older versions to be unreachable?
- Will they not support some features but function normally?
- Will the functionality of query.neurobagel.org be degraded unless all nodes update?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.