diff --git a/.github/ISSUE_TEMPLATE/refactoring_suggestion.md b/.github/ISSUE_TEMPLATE/refactoring_suggestion.md new file mode 100644 index 00000000..9a47d016 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/refactoring_suggestion.md @@ -0,0 +1,40 @@ +--- +name: Refactoring suggestion +about: Suggest a way to improve CAREamics' codebase +title: "[Refactoring]" +labels: refactoring +assignees: '' +--- + +## Description + + +[description here] + +### Which part of the code? + +- [links to code] + +### Examples + +``` python +# [example of the pain points and their consequences] +``` + +## Potential solutions + + + +### [Name of Solution 1] + + + +``` python +# [suggested change to code for Solution 1] +``` + +## References + + + +[additional context here]