Implement a new rule which checks correct order of appearance for template-defined headings - #22
Merged
Merged
Conversation
Neutra1l
commented
Sep 14, 2026
Neutra1l
commented
Member
- Missing headings, either optional or mandatory, are skipped as they are either ok to leave out or handled by Rule 01 respectively
- Interspersed custom headings are ignored.
- OptionalSection.java and MandatorySection.java are merged into one, with a new enum introduced SectionRequirement.java to capture semantics of optionality of sections. Various rules are reworked/refactored slightly as a result of this change.
- README.md updated to include the new rule
Neutra1l
force-pushed
the
rule08_impl
branch
from
September 14, 2026 06:51
7e7f6bf to
d49872f
Compare
Neutra1l
force-pushed
the
rule08_impl
branch
from
September 14, 2026 06:56
593b175 to
66d1685
Compare
Neutra1l
force-pushed
the
rule08_impl
branch
from
September 14, 2026 07:05
90483a3 to
e0a826f
Compare
koppor
approved these changes
Sep 16, 2026
koppor
left a comment
koppor
left a comment
Member
There was a problem hiding this comment.
Follow up:
- Test cases
- Use of OpenFastTrace
| | `MADR05` | Only the title may have heading level 1. | | ||
| | `MADR06` | Headings must have the levels given in the MADR template. | | ||
| | `MADR07` | Consequences (`a`) and Confirmation (`b`), if present, must be level-3 headings under Decision Outcome. | | ||
| | `MADR08` | The Title (`a`) and the level 2 headings defined in the template (`b`) must appear in the correct order. | |
Member
There was a problem hiding this comment.
Follow up: provide an id to each rule. See markdown lint. One can configure per number or per rule id
Member
Author
There was a problem hiding this comment.
Both of these follow ups I think are best handled in separate PRs, as I think they would involve substantial refactoring/rework of the current codebase. For now it would be nice if you can review this and other open PRs on their own merits.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.