Skip to content
/ server Public

Comments

MDEV-38844: Improve CONTRIBUTING.md formatting and consistency#4648

Closed
luckyxhq wants to merge 1 commit intoMariaDB:mainfrom
luckyxhq:docs-improve-contributing-formatting
Closed

MDEV-38844: Improve CONTRIBUTING.md formatting and consistency#4648
luckyxhq wants to merge 1 commit intoMariaDB:mainfrom
luckyxhq:docs-improve-contributing-formatting

Conversation

@luckyxhq
Copy link

Description

This PR improves the CONTRIBUTING.md file by fixing formatting inconsistencies and updating an HTTP link to HTTPS.

Changes Made

  • Standardized header underlines to use 3 dashes consistently (some used 4-5 dashes)
  • Removed double spaces before links throughout the document
  • Added missing space after period on line 22
  • Updated http://mariadb.meetup.com/ to https:// for security

Rationale

  • Consistency: Standardized formatting makes the document easier to read and maintain
  • Professional appearance: Proper spacing and formatting reflect well on the project
  • Security: HTTPS provides encryption and is the modern standard
  • Markdown standards: Consistent header underlines are a markdown best practice

These changes improve document readability and follow markdown best practices.

Fix formatting inconsistencies in CONTRIBUTING.md:
- Standardize header underlines to use 3 dashes consistently
- Remove double spaces before links
- Add missing space after period on line 22
- Update http://mariadb.meetup.com/ to https:// for security

These changes improve document readability and follow markdown
best practices.
@CLAassistant
Copy link

CLAassistant commented Feb 13, 2026

CLA assistant check
All committers have signed the CLA.

@gkodinov gkodinov added the External Contribution All PRs from entities outside of MariaDB Foundation, Corporation, Codership agreements. label Feb 16, 2026
@gkodinov gkodinov changed the title Improve CONTRIBUTING.md formatting and consistency MDEV-38844: Improve CONTRIBUTING.md formatting and consistency Feb 16, 2026
Copy link
Member

@gkodinov gkodinov left a comment

Choose a reason for hiding this comment

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

Thank you for your contribution. This is a preliminary review.
Please re-submit your change against 10.6 : we need to be updating this file across all active versions.
Also, please sort out the CLA bot requirements and make sure the CLA is cleared.

@luckyxhq
Copy link
Author

Closing this PR as I've re-submitted the changes against the 10.6 branch as requested by the maintainers in #4661. The same formatting improvements are now targeting 10.6 for backporting across all active versions.

@luckyxhq luckyxhq closed this Feb 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

External Contribution All PRs from entities outside of MariaDB Foundation, Corporation, Codership agreements.

Development

Successfully merging this pull request may close these issues.

3 participants