chore: fix formatting of CONTRIBUTING.MD - #48
Merged
Conversation
Parts of the texts under "Structuring your commits" was converted to h1 header due to the "---". Fixed this and some other minor cosmetics. Signed-off-by: Mirza Krak <mirza@mkrak.org>
There was a problem hiding this comment.
Pull Request Overview
This PR fixes Markdown formatting issues in CONTRIBUTING.MD where text was incorrectly being rendered as an H1 header due to misuse of "---" (which creates a setext-style heading in Markdown). The fix converts the section to use proper ATX-style heading (###) and improves text wrapping for better readability.
Key Changes
- Converted "Sign your work" from setext-style heading (underlined with "---") to ATX-style heading (### prefix)
- Rewrapped paragraph text for consistent line length
- Replaced the misused "---" separator with proper code fence closure
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Dexter9532
approved these changes
Nov 4, 2025
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
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.
Parts of the texts under "Structuring your commits" was converted to h1 header due to the "---". Fixed this and some other minor cosmetics.