Skip to content

Commit

Permalink
chore: Refactoring template
Browse files Browse the repository at this point in the history
  • Loading branch information
jdeschamps authored Dec 6, 2024
1 parent 095b6df commit cd2eae2
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/refactoring_suggestion.md
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]

0 comments on commit cd2eae2

Please sign in to comment.