From f8944f4f9eea54bcdf5a512713f57abc396a53d4 Mon Sep 17 00:00:00 2001 From: Chirag Kumar Date: Thu, 21 Nov 2024 19:05:47 +0000 Subject: [PATCH] PR and issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 38 +++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 +++++++++ .github/ISSUE_TEMPLATE/ixa_issues_template.md | 41 +++++++++++++++++++ .../ISSUE_TEMPLATE/scientific-improvement.md | 17 ++++++++ .../pull_request_template.md | 28 +++++++++++++ 5 files changed, 144 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/ixa_issues_template.md create mode 100644 .github/ISSUE_TEMPLATE/scientific-improvement.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..dd84ea7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..bbcbbe7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/ixa_issues_template.md b/.github/ISSUE_TEMPLATE/ixa_issues_template.md new file mode 100644 index 0000000..670604a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/ixa_issues_template.md @@ -0,0 +1,41 @@ +--- +name: ixa issue template +about: A template for writing specs for ixa modeling work +title: '' +labels: '' +assignees: '' + +--- + +This template should be used as an outline. It may not be necessary to fill out every section. Delete this block of text and fill in anything in brackets. + +## Goal +[1-3 sentence summary of the issue or feature request. E.g. "We want to improve automatic generation of reports..."] + +## Context +[Short paragraph describing how the issue arose and constraints imposed by the existing code architecture] + +## Required features + +- [Describe each thing you need the code to do to achieve the goal] +- [Example 1: Use a config to set input and output paths] +- [Example 2: Read in some-dataset and output some-transformed-dataset] +- etc... + +## Specifications +[A checklist to keep track of details for each feature. At least one specification per feature is recommended. Edit the example below:] + +- [ ] EX2: A function that reads data from the `some-api` API and returns the dataset +- [ ] EX2: Another function that inputs the dataset, performs $x$ transform, and outputs $y$ +- [ ] EX1: A script that runs the workflow from a config +- [ ] The workflow should run in the VAP from `directory` +- [ ] All functions should have associated unit tests +- [ ] etc. etc. + +## Out of scope + +- [Things out of scope from this issue/PR] + +## Related documents + +- [Link to related scripts, functions, issues, PRs, conversations, datasets, etc.] diff --git a/.github/ISSUE_TEMPLATE/scientific-improvement.md b/.github/ISSUE_TEMPLATE/scientific-improvement.md new file mode 100644 index 0000000..4870c64 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/scientific-improvement.md @@ -0,0 +1,17 @@ +--- +name: Scientific improvement +about: Suggest a way to improve an existing tool or pipeline +title: '' +labels: '' +assignees: '' + +--- + +## Describe the improvement that needs to be made +(e.g. update a parameter estimate, tweak the prior, modify the model) + +## Provide links to references to methods or data sources + +## Describe the changes expected to the model's outputs + +## Suggest new tests that will need to be implemented diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 0000000..450182d --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,28 @@ +## Description + +[To use this template, replace bracketed text with info about your PR] + +## Changes +[Describe the changes made in this pull request, use bullet points if possible]. + +* [Describe key modifications to the code] +* etc. + +## ⚠ Does this PR impact other parts of the model that other developers must be aware of? +[If there are aspects of the interaction between parts of the model not include in Github actions, specify here whether the model could break with this PR.] + +## ⚠ Does this PR impact the input/output file schema/interpretation? +[Describe how other users may need to change their usage of the model based on this PR]. + +## What are outstanding issues? +* [outstanding issue 1] +* [outstanding issue 2] + +⚠️ [Describe anything that needs particular attention from reviewers] +## Checklist +[The checklist is a reminder, not a requirement. Delete items not relevant to your PR] + +- [ ] I have closed issues relevant to this PR by including "closes #ISSUE_NUMBER" in my commit messages. (If you forgot to do this, close the issues in your PR). +- [ ] I have added necessary tests to check new functionality. +- [ ] This PR does not break the pipeline. +- [ ] The README and function documentation have been updated.