docs: enhance CONTRIBUTING.md for new open source contributors ✨✅ #28
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.
Summary
Significantly enhances the
CONTRIBUTING.md
file to provide a clearer, more structured, and welcoming guide for open-source contributors, especially first-timers. Closes #2 .Type of Change
Motivation / Context
The previous contribution guide was technically accurate but lacked structure and guidance for newcomers, making the barrier to entry higher. This change is needed to lower the barrier for first-time open-source contributors, improve the project's overall discoverability, and clearly outline core development practices (testing, style, templates).
Approach
The existing
CONTRIBUTING.md
was reorganized and expanded. New sections were added for:CLI Impact
If this alters user-facing CLI behavior:
Generated Output Impact
List any new / modified scaffold files or structural differences (e.g. new template folder, changed Dockerfile pattern, compose changes, new preset behaviors).
None. This change is exclusively within the project's root documentation.
Tests
Describe test coverage:
It's a Markdown update which can be previewed in any markdown editor and that was done after the updates were made.
Screenshots / Logs (Optional)
N/A. No user-facing CLI output changes.
Docs
README.md
if needed.github/copilot-instructions.md
if internal conventions changedChecklist
templates/