Skip to content

Latest commit

 

History

History
96 lines (67 loc) · 2.71 KB

CONTRIBUTING.md

File metadata and controls

96 lines (67 loc) · 2.71 KB

Contributing to CC CLAUDE.md Flow

First off, thank you for considering contributing to CC CLAUDE.md Flow! 🎉

💡 Philosophy

This project follows a simple philosophy: Brutal honesty and practical solutions over theoretical perfection.

🤝 How to Contribute

Reporting Issues

Found a bug or have a suggestion?

  1. Check existing issues first to avoid duplicates
  2. Create a new issue with:
    • Clear title describing the problem
    • Steps to reproduce (for bugs)
    • Expected vs actual behavior
    • Your environment details (OS, Claude Code version, etc.)

Submitting Changes

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Test thoroughly - all profiles should work
  5. Commit with clear messages (git commit -m 'Add: New workflow pattern for X')
  6. Push to your fork (git push origin feature/amazing-feature)
  7. Open a Pull Request

Pull Request Guidelines

  • One feature per PR - keep it focused
  • Update documentation if needed
  • Test all profiles before submitting
  • Be brutally honest in your PR description

📝 Code Style

For Markdown Files

  • Use consistent formatting
  • Keep line length reasonable (80-120 chars)
  • Use meaningful headers
  • Include practical examples

For Scripts

  • Comment your code (in language of the code)
  • Use descriptive variable names
  • Handle errors gracefully
  • Test on both WSL and native Linux

🚀 Adding New Profiles

Want to add a new specialized profile?

  1. Follow the existing pattern - study current profiles
  2. Define clear purpose - what problem does it solve?
  3. Include autonomous switching logic
  4. Add documentation and examples
  5. Update profile switching scripts

🌍 Translations

We welcome translations!

  1. Create a new branch for your language
  2. Translate documentation (keep code/commands in English)
  3. Maintain the original tone and philosophy
  4. Submit PR with [LANG] prefix (e.g., [SK] Add Slovak translation)

💬 Community Guidelines

  • Be respectful - we're all here to learn
  • Be helpful - share your knowledge
  • Be practical - focus on what works
  • Be honest - if something doesn't work, say it

📧 Questions?

  • Open an issue with [Question] prefix
  • Join our discussions in the Issues section
  • Check existing documentation first

🏆 Recognition

Contributors will be added to our Contributors List with:

  • GitHub handle
  • Contribution type (code, docs, ideas, etc.)
  • Number of contributions

Remember: The best contribution is one that helps someone solve a real problem.

Thank you for making CC CLAUDE.md Flow better! 🚀