Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
141 lines (101 loc) · 3.7 KB

CONTRIBUTING.md

File metadata and controls

141 lines (101 loc) · 3.7 KB
Raw

Contributing to Algo Sensei

Thank you for your interest in contributing to Algo Sensei! 🎉

How to Contribute

Reporting Issues

  • Check existing issues first to avoid duplicates
  • Use a clear, descriptive title
  • Include steps to reproduce (if it's a bug)
  • Explain what you expected vs what happened
  • Share your Claude Code version and OS

Suggesting Enhancements

  • Describe the enhancement in detail
  • Explain why it would be useful
  • Provide examples of how it would work
  • Consider if it fits the project's philosophy

Contributing Code

  1. Fork the repository
  2. Create a branch (git checkout -b feature/your-feature-name)
  3. Make your changes
  4. Test thoroughly - Try the skill in different scenarios
  5. Commit with clear messages (git commit -m "Add: New pattern template for heaps")
  6. Push to your fork (git push origin feature/your-feature-name)
  7. Open a Pull Request

What We're Looking For

High Priority

  • 🌍 Language-specific examples in modes (Java, C++, JavaScript, Go, Rust)
  • 🐛 Bug fixes in existing modes
  • 📚 Improved explanations based on user feedback
  • 🎯 Better pattern recognition prompts in Pattern Mapper mode
  • ✅ Test the skill and report issues

Medium Priority

  • 🛠️ Scripts for automation (test generators, complexity analyzers)
  • 📊 Visual aids (better ASCII diagrams, flowcharts)
  • 🔍 More practical examples in modes
  • 📖 Documentation improvements

Nice to Have

  • 🎨 UI/UX improvements in mode instructions
  • 🌐 Translations (if there's demand)
  • 📹 Demo videos or GIFs
  • 🧪 Edge case examples

Contribution Guidelines

Style Guide

For Markdown files:

  • Use clear headers (##, ###)
  • Include code examples with syntax highlighting
  • Keep lines under 100 characters when practical
  • Use emojis sparingly (only where they add clarity)

For Code Examples:

  • Include comments explaining key steps
  • Use descriptive variable names
  • Show time/space complexity
  • Provide multiple test cases

For Mode Instructions:

  • Be clear and concise
  • Use bullet points and numbered lists
  • Include examples
  • Follow existing mode structure

Mode Enhancement Best Practices

When improving modes:

  • Maintains consistent voice/tone
  • Follows existing structure
  • Adds real value (not just fluff)
  • Tested in actual use
  • No breaking changes to existing behavior

Pull Request Process

  1. Update README if you're adding new features
  2. Test your changes - Actually use the skill in Claude Code
  3. One feature per PR - Keep PRs focused
  4. Write clear PR description - What, why, and how
  5. Be responsive to feedback and questions

Code of Conduct

Our Pledge

We're committed to making Algo Sensei a welcoming, inclusive project:

  • 🤝 Be respectful and constructive
  • 💡 Welcome diverse perspectives
  • 🎯 Focus on what's best for learners
  • 🙏 Be grateful for contributions
  • 🧘 Be patient with beginners

Our Standards

Encouraged:

  • Constructive feedback
  • Graceful disagreement
  • Focus on learning and teaching
  • Sharing knowledge

Not Tolerated:

  • Harassment or discrimination
  • Personal attacks
  • Trolling or inflammatory comments
  • Publishing others' private information

Questions?

  • 💬 Open a Discussion on GitHub
  • 🐛 File an Issue on GitHub
  • 📧 Contact maintainers (if sensitive)

Recognition

Contributors will be:

  • Listed in README (if significant contribution)
  • Credited in release notes
  • Thanked in our community 🙏

License

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

Thank you for making Algo Sensei better for everyone! 🥋