diff --git a/.github/ISSUE_TEMPLATE/data-question.md b/.github/ISSUE_TEMPLATE/data-question.md new file mode 100644 index 0000000..d0dffbc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/data-question.md @@ -0,0 +1,21 @@ +--- +name: Data question +about: Use this to ask a question about or report an issue with the data +title: '' +labels: data +assignees: '' + +--- + +#### What data file(s) does this issue pertain to? + + + +#### What release are you using? + + + + +#### Put your question or report your issue here. + + diff --git a/.github/ISSUE_TEMPLATE/propose-an-analysis.md b/.github/ISSUE_TEMPLATE/propose-an-analysis.md new file mode 100644 index 0000000..ef21cb9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/propose-an-analysis.md @@ -0,0 +1,33 @@ +--- +name: Propose an analysis +about: Use this issue template to propose a new analysis +title: 'Proposed Analysis:' +labels: proposed analysis +assignees: '' + +--- + + + +#### What are the scientific goals of the analysis? + + + +#### What methods do you plan to use to accomplish the scientific goals? + + + +#### What input data are required for this analysis? + + + +#### How long do you expect is needed to complete the analysis? Will it be a multi-step analysis? + + +#### Who will complete the analysis (please add a GitHub handle here if relevant)? + + + +#### What relevant scientific literature relates to this analysis? + + diff --git a/.github/ISSUE_TEMPLATE/update-an-analysis.md b/.github/ISSUE_TEMPLATE/update-an-analysis.md new file mode 100644 index 0000000..50439b0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/update-an-analysis.md @@ -0,0 +1,30 @@ +--- +name: Update an analysis +about: Use this issue template to describe an update to a pre-existing analysis module +title: 'Updated analysis:' +labels: updated analysis +assignees: '' + +--- + + + +#### What analysis module should be updated and why? + + + +#### What changes need to be made? Please provide enough detail for another participant to make the update. + + + +#### What input data should be used? Which data were used in the version being updated? + + + +#### When do you expect the revised analysis will be completed? + + + +#### Who will complete the updated analysis? + + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..3c3e670 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,50 @@ + + +### 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. + +#### Documentation Checklist + +- [ ] This analysis module has a `README` and it is up to date. +- [ ] The analytical code is documented and contains comments.