The documentation should be revised to ensure it is still accurate (this should in fact be done periodically, probably at least once during every development cycle).
Some issues spotted with existing documentation:
- In the README-editors.md template:
- Link to James Overton’s OBO tutorial, which was itself last updated 7 years ago
- Link to the Gene Ontology Editors Tutorial, which was last updated 9 years ago
- Those resources might still be somewhat useful, but we need to balance their usefulness with the risk that they can lead users astray with outdated advice – at this point I think it’s probably better to send users only to the OBOOK.
- In the EditorsWorkflow.md template:
- Recommends using the infamous
-B option: sh run.sh make prepare_release -B (gentle reminder that every time someone recommends using that option, somewhere in the world a Make developer dies – and it’s not as if there were enough Make developers to begin with that we could afford to lose them like that!).
The documentation should be revised to ensure it is still accurate (this should in fact be done periodically, probably at least once during every development cycle).
Some issues spotted with existing documentation:
-Boption:sh run.sh make prepare_release -B(gentle reminder that every time someone recommends using that option, somewhere in the world a Make developer dies – and it’s not as if there were enough Make developers to begin with that we could afford to lose them like that!).