Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PR and issue templates #4

Merged
merged 1 commit into from
Nov 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -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.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -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.
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/ixa_issues_template.md
Original file line number Diff line number Diff line change
@@ -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.]
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/scientific-improvement.md
Original file line number Diff line number Diff line change
@@ -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
28 changes: 28 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -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.
Loading