PULL_REQUEST_TEMPLATE.md
September 12, 2020 ยท View on GitHub
Purpose/implementation Section
What scientific question is your analysis addressing?
What was your approach?
What GitHub issue does your pull request address?
Directions for reviewers. Tell potential reviewers what kind of feedback you are soliciting.
Which areas should receive a particularly close look?
Is there anything that you want to discuss further?
Is the analysis in a mature enough form that the resulting figure(s) and/or table(s) are ready for review?
Results
What types of results are included (e.g., table, figure)?
What is your summary of the results?
Reproducibility Checklist
- The dependencies required to run the code in this pull request have been added to the project Dockerfile.
- This analysis has been added to continuous integration.
Documentation Checklist
- This analysis module has a
READMEand it is up to date. - This analysis is recorded in the table in
analyses/README.mdand the entry is up to date. - The analytical code is documented and contains comments.