-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
19efaf0
commit 3c65b4b
Showing
1 changed file
with
44 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
--- | ||
name: duckup Dev Task Template | ||
about: A template for writing issues | ||
title: '' | ||
labels: ["development task"] | ||
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 be able to ..."] | ||
|
||
## 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 | ||
- [ ] All functions should follow PEP8 package conventions with blah, blah, blah | ||
- [ ] 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.] |