Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
144 lines (100 loc) · 4.17 KB

CONTRIBUTING.md

File metadata and controls

144 lines (100 loc) · 4.17 KB

Contributing to Claude Memory User Edits Guide

First off, thank you for considering contributing to this guide! This is a community-driven resource, and your input makes it better for everyone.

How Can I Contribute?

🧪 Share Your Testing Results

Have you tested memory edits with your own projects? We'd love to hear about:

  • Test scenarios and results (what worked, what didn't)
  • Specific use cases we haven't covered
  • Performance metrics from your projects
  • Edge cases or unexpected behaviors

📝 Submit Examples

Real-world examples are incredibly valuable:

  • Project-specific templates (new project types)
  • Advanced techniques you've discovered
  • Anti-patterns you've encountered
  • Success stories with measurable results

🐛 Report Issues

Found something wrong or unclear?

  • Inaccuracies in the guide
  • Outdated information (Anthropic updates features)
  • Confusing explanations that need clarification
  • Broken links or formatting issues

💡 Suggest Improvements

Have ideas to make this guide better?

  • New sections that would be helpful
  • Better organization of existing content
  • Clearer explanations of complex topics
  • Additional resources to include

Submission Process

For Small Changes (typos, links, minor clarifications):

  1. Open an issue describing the change
  2. If approved, submit a pull request with the fix

For Larger Contributions (new sections, examples, testing results):

  1. Open an issue first to discuss your contribution
  2. Wait for feedback/approval from maintainers
  3. Fork the repository
  4. Create a branch (git checkout -b feature/your-feature-name)
  5. Make your changes
  6. Commit with clear messages (git commit -m "Add: new template for data science projects")
  7. Push to your fork (git push origin feature/your-feature-name)
  8. Open a pull request with:
    • Clear description of changes
    • Why this contribution is valuable
    • Any testing/validation you've done

Contribution Standards

Writing Style

  • Be clear and concise - This is a technical guide, not marketing copy
  • Use examples - Show, don't just tell
  • Be honest - Include limitations and caveats
  • Stay factual - Back claims with evidence or testing
  • Avoid jargon - Or explain it when necessary

Code Examples

  • Use real-world scenarios when possible
  • Include character counts for memory edits
  • Show both good and bad examples
  • Explain why something works or doesn't

Testing Claims

If you're submitting testing results:

  • Describe methodology clearly
  • Share sample sizes (number of tests, conversations)
  • Note limitations of your testing
  • Provide context (project type, complexity, etc.)

What We're Looking For

High Priority:

  • ✅ Testing results from different project types
  • ✅ Real production use cases
  • ✅ Edge cases and limitations
  • ✅ Cross-domain applications

Medium Priority:

  • ⚠️ Alternative approaches or techniques
  • ⚠️ Clarifications of existing content
  • ⚠️ Additional templates or examples

Lower Priority:

  • ℹ️ Minor formatting improvements
  • ℹ️ Typo fixes
  • ℹ️ Link updates

Recognition

Contributors will be acknowledged in:

  • The guide's acknowledgments section
  • Pull request comments
  • Release notes (for significant contributions)

Questions?

Not sure if your contribution fits? Just ask!

  • Open an issue with your question
  • Tag it with question label
  • We'll discuss and help you contribute effectively

Code of Conduct

Be respectful:

  • Constructive feedback only
  • No personal attacks
  • Stay professional
  • Assume good intentions

Be collaborative:

  • Help others improve their contributions
  • Share knowledge generously
  • Credit others' work appropriately

License

By contributing, you agree that your contributions will be licensed under the same CC BY 4.0 license as the rest of the guide.

Thank you for helping make this guide better for everyone!

If you have questions about contributing, open an issue or reach out to Francesco Marinoni Moretto.