> …to refactor and improve the quality of a microservice.
> …
> It worked. It vastly improved the code base…
Would you be up for sharing before refactor and after refactor versions of your experiment in a public repo?
Thanks in advance.
- 1. Read the whole code of the repository.
- 2. Read the TASKS.md file if it exists.
- 2.1. If it exists and is not empty, pick a refactoring task from the list. Choose the most appropriate.
- 2.1.1. Refactor the code according to the task description.
- 2.1.2. Commit the changes to git.
- 2.1.3 Remove the task from TASKS.md
- 2.1.3. You are done.
- 2.2. If it doesn't exist or is empty:
- 2.2.1. Identify the parts of the code that could be refactored, following the following principles
- A class should have a single responsability
- The dependencies of the class should be mockable and injected at class instanciation
- Repeated code should be factored into functions
- Files shouldn't be longer than 1.5K lines
- 2.2.2: If using the previous insights you think there is valuable refactoring work to be done:
- 2.2.2.1 Write a list of refactoring tasks in TASKS.md
- 2.2.2.2: You are done.
- 2.2.3: If there is no more refactoring to be done, notify me with 'say "I am done with refactoring"' > …Read the TASKS.md file if it exists…
Having the same tasks would help me nail a similar successful result.
I forgot to also ask: What language and which REST framework was your microservice implemented with?
For even better reproducibility, I'm thinking I should have my codebase be as similar to yours as I can get it.
TIA!
The service was in go, but this doesn't matter.