-
Notifications
You must be signed in to change notification settings - Fork 0
Open
3 / 33 of 3 issues completedDescription
🧾 Description
This is a persistent, umbrella issue for any refactoring tasks across the codebase.
Developers who begin a refactor should:
- Create a dedicated branch (see “🌱 Branch”).
- Link their pull request to this issue so the discussion and history stay centralized.
- Close their individual refactor PRs when merged; do not close this umbrella issue.
Why?
- Maintain code quality and consistency.
- Reduce technical debt incrementally.
- Provide a single place to track refactor efforts.
🛠 Implementation steps
- Identify the area of the code that needs refactor and briefly describe it in your PR.
- Create a branch named
refactor/<short-topic>-<issue-number>(e.g.refactor/auth-service-123). - Ensure the branch description and PR body reference this issue (e.g. “Closes refactor(backend)!: Simplify contributors endpoint to return all unique names without ranking #123”).
- Perform the refactor, keeping changes focused and atomic.
- Update or add tests to cover the refactored code.
- Open a PR targeting
dev(or main development branch) and request review. - After approval, merge the PR and delete the feature branch.
🗂 Labels
scope:sharedtype:refactorprio:low
🧑💻 Assignee (still optional)
None – developers can self-assign when they start a refactor task.
🌱 Branch
Branches should follow the pattern:
refactor/<short-topic>-<issue-number>
📁 Code location(s)
Varies per refactor task – specify in your PR (e.g.
libs/utils/src/dateHelpers.ts).
📆 Milestone
Continuous Improvement
🧪 Acceptance criteria
- Works according to the description of the individual refactor PR.
- All unit/integration tests pass.
- Manual smoke test confirms no regressions.
- Branch has been merged into the
devbranch (or mainline).