Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
114 lines (89 loc) · 2.57 KB

CONTRIBUTING.md

File metadata and controls

114 lines (89 loc) · 2.57 KB

Contributing to Git Worktree Boss Mode

Thank you for your interest in contributing! This project welcomes contributions from everyone.

How to Contribute

1. Fork the Repository

  • Click the "Fork" button on GitHub
  • Clone your fork locally: 
    git clone git@github.com:YOUR-USERNAME/test-workspace-worktree.git
cd test-workspace-worktree

2. Create a Feature Branch Using Worktrees!

Practice what we preach - use worktrees for your contributions:

./worktree-manager.sh create feature/your-awesome-feature
cd worktrees/feature/your-awesome-feature

3. Make Your Changes

  • Follow the existing code style
  • Add tests if applicable
  • Update documentation as needed
  • Test your changes thoroughly

4. Commit Your Changes

git add .
git commit -m "Add: Brief description of your changes"

5. Push to Your Fork

git push origin feature/your-awesome-feature

6. Create a Pull Request

  • Go to your fork on GitHub
  • Click "New Pull Request"
  • Select your feature branch
  • Fill in the PR template with:
    • What changes you made
    • Why you made them
    • How to test them

Contribution Guidelines

Code Style

  • Use clear, descriptive variable names
  • Comment complex logic
  • Follow existing patterns in the codebase

Commit Messages

  • Use present tense ("Add feature" not "Added feature")
  • Keep first line under 50 characters
  • Reference issues and pull requests where applicable

Types of Contributions

  • 🐛 Bug fixes
  • ✨ New features
  • 📝 Documentation improvements
  • 🎨 UI/UX improvements
  • ♻️ Code refactoring
  • ✅ Tests
  • 🔧 Configuration changes

Reporting Issues

  • Use the GitHub issue tracker
  • Check if the issue already exists
  • Include steps to reproduce bugs
  • Provide system information when relevant

Development Setup

  1. Install dependencies (if any):

    # Add your setup commands here

  2. Run tests:

    # Add your test commands here

Code of Conduct

Our Standards

  • Be respectful and inclusive
  • Welcome newcomers and help them get started
  • Focus on constructive criticism
  • Respect differing opinions

Unacceptable Behavior

  • Harassment or discrimination
  • Personal attacks
  • Trolling or insulting comments
  • Public or private harassment

Questions?

Feel free to:

  • Open an issue for questions
  • Reach out to maintainers
  • Check existing documentation

License

By contributing, you agree that your contributions will be licensed under the same license as the project.

Thank you for contributing to make this project even more awesome! 🚀