-
Notifications
You must be signed in to change notification settings - Fork 6
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
095b6df
commit cd2eae2
Showing
1 changed file
with
40 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,40 @@ | ||
--- | ||
name: Refactoring suggestion | ||
about: Suggest a way to improve CAREamics' codebase | ||
title: "[Refactoring]" | ||
labels: refactoring | ||
assignees: '' | ||
--- | ||
|
||
## Description | ||
<!-- A description of the current pain points. --> | ||
|
||
[description here] | ||
|
||
### Which part of the code? | ||
|
||
- [links to code] | ||
|
||
### Examples | ||
|
||
``` python | ||
# [example of the pain points and their consequences] | ||
``` | ||
|
||
## Potential solutions | ||
|
||
<!-- Describe potential solutions in different sections. --> | ||
|
||
### [Name of Solution 1] | ||
|
||
<!-- A description of a potential solution. --> | ||
|
||
``` python | ||
# [suggested change to code for Solution 1] | ||
``` | ||
|
||
## References | ||
|
||
<!-- Add any other context, links to other codebase, PEP, best practices, etc. that could help understand or validate the solution --> | ||
|
||
[additional context here] |