From 6473910977ccad33de4dd53ce29755782e27b8d7 Mon Sep 17 00:00:00 2001 From: Krutika Gaonkar Date: Wed, 23 Sep 2020 15:33:20 -0400 Subject: [PATCH] templates for issues and PR --- .github/ISSUE_TEMPLATE/data-question.md | 20 +++++++++ .github/ISSUE_TEMPLATE/propose-an-analysis.md | 27 ++++++++++++ .github/ISSUE_TEMPLATE/report-issue.md | 22 ++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 41 +++++++++++++++++++ 4 files changed, 110 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/data-question.md create mode 100644 .github/ISSUE_TEMPLATE/propose-an-analysis.md create mode 100644 .github/ISSUE_TEMPLATE/report-issue.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/data-question.md b/.github/ISSUE_TEMPLATE/data-question.md new file mode 100644 index 0000000..2df9d70 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/data-question.md @@ -0,0 +1,20 @@ +--- +name: Data question +about: Use this to ask a question about or report an issue with the data provided with annoFuse +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..39d8b41 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/propose-an-analysis.md @@ -0,0 +1,27 @@ +--- +name: Propose an analysis +about: Use this issue template to propose a new analysis +title: 'Proposed Analysis:' +labels: proposed analysis +assignees: '' + +--- + + + +### Purpose/implementation Section + +#### Briefly descibe the analysis and provide meaningful references + + +#### What input data are required for this analysis? + + +#### How do you plan to organise the analysis,will it be a multi function call or add to existsing functions? + + +#### Who will complete the analysis (please add a GitHub handle here if relevant)? + + + + diff --git a/.github/ISSUE_TEMPLATE/report-issue.md b/.github/ISSUE_TEMPLATE/report-issue.md new file mode 100644 index 0000000..ea1d3e9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/report-issue.md @@ -0,0 +1,22 @@ +--- +name: Report an issue +about: Use this to ask a question about or report an issue with annoFuse +title: 'Report an issue' +labels: Report an issue +assignees: '' + +--- + +#### Provide the command used or report your issue here + + +#### What release are you using? + + +#### Add error message here + + +#### Add Session info +Run `sessionInfo()` and post the output below + + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..4bf21db --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,41 @@ + + +### Purpose/implementation Section + +#### What feature is being added ? + + +#### 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? + + +#### Documentation Checklist + + + +- [ ] The function has examples to showcase the usage +- [ ] The function is fully documented in the package using roxygen +- [ ] Added a vignette + +#### Package Checklist + + + +- [ ] The dependencies required for the function in this pull request has been added to [DESCRIPTION](https://github.com/d3b-center/annoFuse/blob/master/DESCRIPTION) `Imports` section +- [ ] The files needed for the function to run are in inst/extdata +- [ ] The code wa run through styler + +