Skip to content

docs: add comprehensive contributing guide#50

Open
fahd04 wants to merge 1 commit intodwmkerr:mainfrom
fahd04:docs/add-contributing-guide
Open

docs: add comprehensive contributing guide#50
fahd04 wants to merge 1 commit intodwmkerr:mainfrom
fahd04:docs/add-contributing-guide

Conversation

@fahd04
Copy link

@fahd04 fahd04 commented Jan 12, 2026

Summary

This PR adds a comprehensive CONTRIBUTING.md guide to help new and existing contributors understand how to contribute to Shellwright.

The structure and format is based on the contributing guide from agents-at-scale-ark, adapted to fit Shellwright's specific needs and workflow.

What's included:

  • Ways to contribute: Multiple paths for community involvement (bugs, features, reviews, documentation, themes, examples)
  • Development setup: Complete guide from fork to testing with multiple workflow options
  • Code standards: Conventional commit format, testing requirements, code style guidelines
  • Pull request process: Step-by-step workflow for submitting contributions
  • Common tasks: Practical examples for adding tools, fixing bugs, and improving docs
  • Theme contribution: Specific guide for adding new color themes

Why this matters:

  • Lowers the barrier for first-time contributors
  • Ensures consistent contribution practices
  • Documents the project's development workflow
  • Provides clear guidelines for conventional commits and semantic versioning

This is my first open source contribution, and I wanted to start by making it easier for others to contribute too! 🚀

Checklist:

  • Follows conventional commit format
  • Documentation is clear and comprehensive
  • Includes practical examples
  • Compatible with existing project structure

Add CONTRIBUTING.md with guidelines for:
- Ways to contribute (bugs, features, docs, themes)
- Development setup and workflow
- Code style and testing requirements
- Pull request process
- Conventional commit format

This helps new contributors understand how to get started
and ensures consistent contribution practices.
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.

2 participants