OpenTransplant icon indicating copy to clipboard operation
OpenTransplant copied to clipboard

Algorithm Spec Template

Open widal001 opened this issue 3 years ago • 0 comments

Summary

Create a template for the algorithmic specifications referenced in #57

Tasks

  • [ ] Create an algorithm-specs/ directory
  • [ ] Create algorithm-specs/README.md which provides the instructions for creating an algorithm spec
  • [ ] Create algorithm-specs/TEMPLATE.md which will be used as the foundation of future algorithm specifications
  • [ ] Create .github/ISSUE_TEMPLATE/algorithm-spec.md which will be the issue type used for new algorithms

Definition of Done

  • [ ] An algorithmic advisor can follow the instructions in algorithm-specs/README.md to create a specification for each of the algorithms listed in #57
  • [ ] After creating a specification using the algorithm-spec/TEMPLATE.md, an algorithmic advisor can signal that the algorithm is ready for a contribution by creating an issue using the .github/ISSUE_TEMPLATE/algorithm-spec.md issue type
  • [ ] A contributor who wants to develop an algorithm for the project has access to all of the information they need, including sample inputs and outputs to validate the accuracy of their algorithm, by referencing a specification created using the algorithm-spec/TEMPLATE.md and the issue created using the .github/ISSUE_TEMPLATE/algorithm-spec.md issue template

widal001 avatar Jul 15 '21 01:07 widal001