Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (47 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

69 lines (47 loc) · 2.25 KB
Raw

Contributing to Code Improving Agent Project

Thank you for your interest in contributing to this project! We welcome contributions from everyone.

Getting Started

  1. Fork the Repository: Start by forking the repository to your GitHub account.

  2. Clone Your Fork:

    git clone https://github.com/YOUR-USERNAME/code-agent-project.git
cd code-agent-project

  3. Set Up the Development Environment:

    python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
pip install -r requirements.txt
pip install -e .  # Install package in development mode

  4. Create a Branch:

    git checkout -b feature/your-feature-name

Development Guidelines

Code Style

  • Follow PEP 8 style guidelines for Python code.
  • Use meaningful variable and function names.
  • Add docstrings to all functions, classes, and modules.

Testing

  • Write tests for new features or bug fixes.
  • Ensure all tests pass before submitting a pull request.
  • Run tests using pytest.

Commit Messages

  • Use clear and descriptive commit messages.
  • Start with a short summary line followed by a more detailed explanation.
  • Reference issues and pull requests where appropriate.

Pull Request Process

  1. Update Documentation: Update the README.md and other documentation with details of changes if needed.

  2. Run Tests: Ensure your code passes all tests.

  3. Submit Pull Request: Push your changes to your fork and submit a pull request to the main repository.

  4. Code Review: Wait for code review and address any comments or suggestions.

  5. Merge: Once approved, your pull request will be merged into the main branch.

Reporting Issues

  • Use the GitHub issue tracker to report bugs or suggest enhancements.
  • Clearly describe the issue including steps to reproduce when it is a bug.
  • Include code samples, error messages, and screenshots when possible.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

Questions or Need Help?

Feel free to open an issue or reach out to the maintainers if you need help or have questions about contributing.