-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* adr: Treat warnings as errors * build: Treat warnings as errors * fix: Compilation warnings
- Loading branch information
1 parent
4a5845f
commit 2173e3b
Showing
4 changed files
with
51 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# 18. Treat Warnings as Errors | ||
|
||
Date: 2024-02-28 | ||
Creator: Guillermo Calvo | ||
Reviewer: Sergio del Amo | ||
|
||
## Status | ||
|
||
Accepted | ||
|
||
|
||
## Context | ||
|
||
We want to avoid as many bugs as possible. | ||
|
||
Some compilation warnings rarely cause any problems, but some others can lead to program malfunction. | ||
|
||
There are codebases in which a regular compilation generates a lot of "known warnings" that have to be ignored. | ||
In those scenarios, new warnings tend to be completely ignored. | ||
|
||
We'd like to make sure that new compilation warnings are looked into. | ||
|
||
While a sensible correction of the offending code is the most desirable outcome of the research, | ||
it is possible that the specific warning has to be suppressed via Java annotations or a similar mechanism. | ||
In any case, solving or suppressing each warning must be the result of a thoughtful decision. | ||
|
||
|
||
## Decision | ||
|
||
We will treat all compilation warnings as errors. | ||
This comment has been minimized.
Sorry, something went wrong.
This comment has been minimized.
Sorry, something went wrong. |
||
|
||
|
||
## Consequences | ||
|
||
- The build will fail if changes introduce any compilation warnings. | ||
- Adopting this philosophy early in the project will make it easier to maintain overall quality throughout development. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
With Corretto-21.0.2.13.1 (build 21.0.2+13-LTS) I am currently seeing the following warning(s):