Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
258 lines (203 loc) · 5.75 KB

CONTRIBUTING.md

File metadata and controls

258 lines (203 loc) · 5.75 KB
Raw

Contributing to ClaudeAutoPM

Thank you for your interest in contributing to ClaudeAutoPM! This project uses a flexible hybrid workflow that adapts to different types of contributions.

🎯 Quick Start

For Small Changes (Direct Commits)

If you're a trusted contributor making small fixes:

git checkout main
git pull origin main
# Make your changes
npm test
git commit -m "fix: description"
git push origin main

For Features (Pull Requests)

For new features or if you're a new contributor:

git checkout -b feat/your-feature
# Make your changes
npm test
git commit -m "feat: description"
git push origin feat/your-feature
# Open PR on GitHub

📊 Contribution Decision Tree

graph TD
    Start[Want to contribute?] --> Q1{Trusted contributor?}
    Q1 -->|Yes| Q2{Type of change?}
    Q1 -->|No| PR[Create Pull Request]
    Q2 -->|Hotfix/Docs| Direct[Direct Commit]
    Q2 -->|Feature| Q3{Size?}
    Q3 -->|Small| Direct
    Q3 -->|Large| PR
    Q2 -->|Breaking| PR
Loading

🔧 Development Setup

  1. Clone the repository

    git clone https://github.com/rafeekpro/ClaudeAutoPM.git
cd ClaudeAutoPM

  2. Install dependencies

    npm install

  3. Run tests

    npm test

  4. Install locally for testing

    npm link
autopm --help

📝 Commit Guidelines

We use Conventional Commits for all contributions:

  • feat: New feature
  • fix: Bug fix
  • docs: Documentation
  • style: Formatting (no code change)
  • refactor: Code restructuring
  • test: Adding tests
  • chore: Maintenance

Good Commit Messages

✅ fix: resolve installation error on Windows ✅ feat: add GitLab CI/CD support ✅ docs: clarify Azure DevOps setup

Bad Commit Messages

❌ fixed stuff ❌ update ❌ wip

🚦 When to Use Each Workflow

Direct Commits ✅

Appropriate for:

  • Critical hotfixes
  • Documentation typos
  • Small bug fixes
  • Config updates
  • Trusted contributors

Requirements:

  • Pass all tests locally
  • Follow commit conventions
  • Small, focused changes

Pull Requests 🔄

Required for:

  • New features
  • Breaking changes
  • Large refactors
  • External contributors
  • Dependency updates
  • Experimental work

Benefits:

  • Code review
  • CI/CD validation
  • Discussion platform
  • Change documentation

🧪 Testing

This project follows strict TDD methodology. Before submitting any contribution:

  1. Run all tests

    npm test                    # Jest unit tests
npm run test:node          # Node.js native tests
npm run test:security      # Security validation
npm run test:regression    # Regression tests

  2. Run linting

    npm run lint
npm run lint:fix

  3. Test installation scenarios

    npm run test:install       # Installation validation
npm run test:install:scenarios

  4. For new features - TDD approach REQUIRED

    • Write failing tests FIRST - Before implementing any code
    • Create test files in test/ directory
    • Use Jest framework for new tests
    • Follow existing patterns in test/unit/ and test/integration/
    • Ensure 100% coverage for new code

🏗️ Project Structure

AUTOPM/
├── autopm/           # Framework resources
│   └── .claude/      # Claude configuration
├── bin/              # CLI executables
├── install/          # Installation scripts
├── test/             # Test suites
└── docs/             # Documentation

🔄 CI/CD Pipeline

Our GitHub Actions run on:

  • Direct commits to main: Quick validation
  • Pull requests: Comprehensive testing

What Gets Tested

  • Installation scenarios
  • Security checks
  • Docker integration (if applicable)
  • Kubernetes deployment (if applicable)
  • Cross-platform compatibility

💡 Development Tips

Local Testing

# Test installation locally
./install/install.sh /tmp/test-project

# Test specific scenario
echo "1" | ./install/install.sh /tmp/test-minimal

# Test CLI commands
node bin/autopm.js --help

Debug Mode

# Enable verbose output
export VERBOSE=1
npm test

# Debug installation
export AUTOPM_DEBUG=1
autopm install

🎯 Areas for Contribution

High Priority

  • Additional CI/CD platform support (GitLab CI, Jenkins)
  • Windows compatibility improvements
  • More language-specific templates
  • Performance optimizations
  • Agent registry expansion (currently 50+ agents)

Good First Issues

  • Documentation improvements
  • Add more examples to autopm/.claude/examples/
  • Improve error messages in commands
  • Add unit tests for existing commands
  • Update agent documentation

Feature Ideas

  • Web UI for configuration
  • Plugin system for custom commands
  • More specialized AI agents
  • Integration with more project management tools
  • Context optimization features

🤝 Code of Conduct

Be Respectful

  • Constructive feedback only
  • Help newcomers
  • Respect different opinions

Be Professional

  • Stay on topic
  • No spam or self-promotion
  • Follow GitHub's terms

📞 Getting Help

🏆 Recognition

Contributors are recognized in:

  • Release notes
  • Contributors file
  • Project README

📜 License

By contributing, you agree that your contributions will be licensed under the MIT License.

🔐 Security

For security vulnerabilities, please email directly instead of opening a public issue.

Thank you for helping make ClaudeAutoPM better! 🚀