Skip to content

Feature/new issue template for investigations #461

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.

Sign up for GitHub

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

Merged
KaleabTessera merged 3 commits into from
Mar 25, 2022
Merged

Feature/new issue template for investigations #461

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4226625
feat: Added investigation template.
KaleabTessera Mar 23, 2022
7602dff
chore: Minor updates to investigation template.
KaleabTessera Mar 23, 2022
8edfdfc
Merge branch 'develop' into feat/new-issue-template-for-investigations
KaleabTessera Mar 24, 2022
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
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/investigation_internal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: Investigation
about: Outline the structure for an investigation. This would commonly be used to measure the impact of various design/implementation choices.
title: '[INVESTIGATION]'
labels: investigation
assignees: ''

---

### What do you want to investigate?
A brief description of what you would like to investigate. Do you have a hypothesis?

### Definition of done
A precise outline for the investigation to be considered complete.

### [***Optional***] Results
<!-- This is added after the investigation is complete. -->
Results from experiments/derivations. This could be linked to a benchmarking issue.

### What was the conclusion of your investigation?
<!-- This is added after the investigation is complete. -->
- What are the findings from the investigation?
- Was your hypothesis correct?

### [***Optional***] Discussion/Future Investigations
<!-- This is added after the investigation is complete. -->
This could be a link to a Github [discussions page](https://github.com/instadeepai/Mava/discussions).

<!-- Base checklist. Don’t hesitate to adapt it to your use-case. -->