Skip to content

Conversation

rahmlad-aramide
Copy link
Contributor

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

  • Feature
  • Bug fix
  • Chore / Refactor
  • Docs
  • Tests
  • CI / Build
  • Other

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:

  1. Onboarding: A dedicated section for "First-Time Contributors" with tips.
  2. Workflow Clarity: Separating "Getting Started" from "Running, Testing, and Debugging."
  3. Best Practices: Expanded guidance on adding Service Templates and External Generators with design principles.
  4. Standards: Beefed up Code Style and Commit Message Conventions with examples.
  5. Future Focus: Added a Roadmap section to encourage involvement in future features.

CLI Impact

If this alters user-facing CLI behavior:

  • Added / changed flags? Describe. No.
  • Backward compatible? N/A (Documentation change).
  • Sample invocation before vs after:
# N/A
# N/A

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:

  • Added new test(s)
  • Updated existing test(s)
  • Manually smoke-tested locally
  • No tests needed (explain why)

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

  • Updated README.md if needed
  • Updated .github/copilot-instructions.md if internal conventions changed
  • Not applicable (Only the contribution guide was targeted)

Checklist

  • Code follows existing style (chalk usage, emoji prefixes, exit codes)
  • No accidental large asset additions outside templates/
  • Default ports preserved / conflicts handled
  • New service templates added to: choices array, defaultPorts, Dockerfile switch, compose mapping (N/A, no new templates)
  • Git history clean (no stray debug commits)
  • Dependency additions are minimal & justified (N/A, no dependency changes)

Expands the contribution guide to be more welcoming and comprehensive for first-time contributors.
>
> Key additions:
- Added a 'First-Time Contributors' section with onboarding tips.
- Clarified running, testing, and debugging the CLI locally.
- Documented best practices for template and external generator creation.
- Expanded code style and commit message guidelines with examples.
@rahmlad-aramide
Copy link
Contributor Author

rahmlad-aramide commented Oct 8, 2025

Here is my PR as earlier mentioned @BhaskarKulshrestha

cc: @kaifcoder

@BhaskarKulshrestha BhaskarKulshrestha self-requested a review October 8, 2025 12:10
Copy link
Collaborator

@BhaskarKulshrestha BhaskarKulshrestha left a comment

Choose a reason for hiding this comment

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

Looks Good, Approving the changes

@BhaskarKulshrestha BhaskarKulshrestha merged commit f848fd6 into kaifcoder:main Oct 8, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation: Improve Contribution Guide for Open Source Contributors

2 participants