Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: Add documentation for all available rules #435

Merged
merged 3 commits into from
Dec 9, 2024
Merged

feat: Add documentation for all available rules #435

merged 3 commits into from
Dec 9, 2024

Conversation

matz3
Copy link
Member

@matz3 matz3 commented Dec 3, 2024 •
edited
Loading

JIRA: CPOUI5FOUNDATION-958

@matz3 matz3 marked this pull request as draft December 3, 2024 10:25
codeworrior
codeworrior reviewed Dec 3, 2024
View reviewed changes
Copy link
Member

@codeworrior codeworrior left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Content LGTM, but in the last bullet point in the commit message, I would say "Add ruleId to Markdown" (the addtl. "name" looks somewhat redundant).

flovogt
flovogt reviewed Dec 6, 2024
View reviewed changes
Copy link
Member

@flovogt flovogt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, only one minor comment

docs/Rules.md Outdated Show resolved Hide resolved
@matz3 matz3 marked this pull request as ready for review December 6, 2024 09:01
@matz3 matz3 requested review from KlattG and a team December 6, 2024 09:01
KlattG
KlattG suggested changes Dec 6, 2024
View reviewed changes
Copy link
Contributor

@KlattG KlattG left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some small suggestions, otherwise fine.

README.md Outdated Show resolved Hide resolved
docs/Rules.md Outdated Show resolved Hide resolved
docs/Rules.md Outdated Show resolved Hide resolved
@matz3 matz3 requested review from a team and removed request for a team December 9, 2024 08:44
@matz3
Copy link
Member Author

matz3 commented Dec 9, 2024

I'll do an interactive rebase to combine the changes into two commits (docs + markdown formatter).

matz3 and others added 3 commits December 9, 2024 14:29
@matz3 @flovogt @KlattG
docs: Add documentation for all available rules
ea07052 
Co-authored-by: Florian Vogt <[email protected]>
Co-authored-by: Günter Klatt <[email protected]>
@maxreichmann @matz3
feat: Add ruleId to Markdown format output
81b2e6a 
The `ruleId` links to the corresponding rule documentation.
@matz3
docs: Rename PERFORMANCE.md
e484d0c 
To align with naming convention.
@matz3 matz3 force-pushed the add-rules-documentation branch from 5d28da8 to e484d0c Compare December 9, 2024 13:32
@matz3
Copy link
Member Author

matz3 commented Dec 9, 2024

Ready for final review.

@matz3 matz3 merged commit e0c69f4 into main Dec 9, 2024
13 checks passed
@matz3 matz3 deleted the add-rules-documentation branch December 9, 2024 15:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@codeworrior codeworrior codeworrior left review comments

@KlattG KlattG KlattG approved these changes

@flovogt flovogt flovogt approved these changes

@RandomByte RandomByte Awaiting requested review from RandomByte

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@matz3 @codeworrior @flovogt @KlattG @maxreichmann