Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
157 lines (105 loc) · 4.89 KB

CONTRIBUTING.md

File metadata and controls

157 lines (105 loc) · 4.89 KB
Raw

Contributing to Agent Compass

Thank you for your interest in contributing to Agent Compass! This document provides guidelines for contributing to the project.

How to Contribute

1. Reporting Issues

If you encounter any problems or have suggestions for improvements:

  1. Search existing issues first to avoid duplicates
  2. Use the issue templates when available
  3. Provide detailed information including:
    • Your operating system and Cursor IDE version
    • Steps to reproduce the issue
    • Expected vs. actual behavior
    • Any error messages or logs

2. Suggesting Enhancements

We welcome suggestions for new rules, improvements to existing ones, or additional language support:

  1. Open an issue with the "enhancement" label
  2. Describe the problem the enhancement would solve
  3. Provide examples of how it would work
  4. Consider backward compatibility with existing rules

3. Contributing Code

Rules Improvements

If you want to improve or add new rules:

  1. Fork the repository
  2. Create a new branch for your changes
  3. Test your changes with real coding scenarios
  4. Update documentation if necessary
  5. Submit a pull request with a clear description

Documentation Improvements

Documentation improvements are always welcome:

  1. Fix typos or unclear explanations
  2. Add more examples to illustrate concepts
  3. Improve installation instructions
  4. Translate documentation (if applicable)

Development Guidelines

Rule Development Standards

When contributing new rules or modifying existing ones:

  1. Follow the existing structure and formatting
  2. Use clear, actionable language
  3. Provide examples for complex rules
  4. Consider edge cases and potential conflicts
  5. Test with multiple programming languages when applicable

Testing Your Changes

Before submitting a pull request:

  1. Test the rules with various coding scenarios
  2. Verify compatibility with different project types
  3. Check for conflicts with existing rules
  4. Ensure proper formatting and syntax

Documentation Standards

When updating documentation:

  1. Use clear, concise language
  2. Provide practical examples
  3. Follow the existing formatting style
  4. Update the table of contents if adding new sections

Pull Request Process

  1. Create a descriptive title for your pull request
  2. Fill out the pull request template completely
  3. Link any related issues using keywords (e.g., "Fixes #123")
  4. Provide a detailed description of your changes
  5. Include examples of how the changes work
  6. Be responsive to feedback and requested changes

Code of Conduct

Our Standards

  • Be respectful and inclusive in all interactions
  • Focus on constructive feedback and collaboration
  • Help others learn and improve
  • Accept feedback gracefully and be open to different perspectives

Unacceptable Behavior

  • Harassment, discrimination, or offensive language
  • Personal attacks or inflammatory comments
  • Spam or off-topic discussions
  • Sharing private information without consent

Language-Specific Contributions

If you want to add support for a new programming language:

  1. Research the language's official style guides and best practices
  2. Create a new section in the rules following the existing format
  3. Include specific examples for that language
  4. Test thoroughly with real projects in that language
  5. Update the README to mention the new language support

Examples of Good Contributions

Rule Improvements

  • Adding specific security guidelines for a programming language
  • Improving error handling recommendations
  • Adding new commenting standards or conventions

Documentation Improvements

  • Adding more practical examples
  • Improving installation instructions for different platforms
  • Creating troubleshooting guides

Bug Fixes

  • Fixing conflicts between rules
  • Correcting typos or formatting issues
  • Improving rule clarity and specificity

Getting Help

If you need help with contributing:

  1. Check the documentation first
  2. Search existing issues for similar questions
  3. Open a new issue with the "question" label
  4. Join the discussion in existing issues and pull requests

Recognition

Contributors will be recognized in the following ways:

  • Listed in the README as contributors
  • Mentioned in release notes for significant contributions
  • Given credit in documentation for major improvements

License

By contributing to Agent Compass, you agree that your contributions will be licensed under the same MIT License that covers the project.

Thank you for helping make Agent Compass better for everyone! 🚀