Skip to content

Commit

Permalink
CODING.md: some tips about refactorings (canonical#14857)
Browse files Browse the repository at this point in the history 
from recent discussions with team members

* CODING.md: afterward angle
* CODING.md: applying Graham's suggestion
  • Loading branch information
@pedronis
pedronis authored Dec 16, 2024
1 parent e5ccc39 commit 789385a
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CODING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,8 @@ The CI tooling will check and enforce the order and required sections when a spr

* Large mechanical refactoring and changes should be done as separate PRs. Try to separate behaviour changes and refactoring into different PRs and not mix the two.

* Refactoring should not touch preexisting tests. If changing a test is unavoidable, changes must be minimal. To ensure a refactor can be anchored, it's a good idea to check the coverage before starting, both in terms of lines of codes and in the features and behaviors that may be affected. Checking the coverage afterwards can also reveal whether there is old code that now can be dropped.

* Large moving of code around and changes to code placement might also be better done separately.

* PR summaries and the first line of commit messages are expected to be of this form:
Expand Down

0 comments on commit 789385a

Please sign in to comment.