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

Feature/internal bug issue template #381

Merged
merged 4 commits into from
Feb 4, 2022
Merged
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
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/bugfix_internal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
name: Bug fix
about: Fix a known bug
title: "[BUG]"
labels: bug
assignees: ''

---

### Describe the bug
A clear and concise description of what the bug is.

### To Reproduce
Steps to reproduce the behavior:
1.
2.
3.
4.

### Expected behavior
A clear and concise description of what you expected to happen.

### Context (Environment)
- Mava (and other package versions): result of `pip freeze > requirements.txt`
- OS

Add any other context about the problem here.

### Proposal for a fix
A plan or brief overview of how the feature will be implemented.

### Definition of done
A precise outline for the feature to be considered fully implemented, i.e. done/complete.

### Mandatory checklist before making a PR
* [ ] The success criteria laid down in “Definition of done” are met.
* [ ] Code is documented - docstrings for methods and classes, static types for arguments.
* [ ] Code is tested - unit, integration and/or functional tests are added.
* [ ] Documentation is updated - README, CONTRIBUTING, or other documentation.
* [ ] All functional tests are green.
* [ ] Link experiment/benchmarking after implementation (optional).

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

### Links / references / screenshots
<!-- For ex: link to CI job, experiment runs, etc. -->