Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
73 lines (53 loc) · 2.2 KB

CONTRIBUTING.md

File metadata and controls

73 lines (53 loc) · 2.2 KB

Contributing to CodeEvolve

Thank you for your interest in contributing to CodeEvolve! We welcome contributions from the community and appreciate your efforts to improve the framework.

Getting Started

  1. Check existing issues: Browse open issues to see if your idea or bug has already been reported
  2. Create an issue first: Before starting work, open an issue describing your proposed change, bug fix, or feature
  3. Wait for feedback: Discuss your approach with maintainers to ensure alignment with project goals

Contribution Workflow

1. Fork and Clone

git clone https://github.com/YOUR_USERNAME/science-codeevolve.git
cd science-codeevolve

2. Create a Branch

git checkout -b feature/your-feature-name

3. Make Changes

  • Write clear, documented code
  • Follow existing code style and conventions
  • Add tests for new functionality
  • Update documentation as needed

4. Test Your Changes

# Run tests to ensure nothing breaks
pytest tests/

5. Commit and Push

git add .
git commit -m "Brief description of changes"
git push origin feature/your-feature-name

6. Submit a Pull Request

  • Reference the related issue number
  • Provide a clear description of what your PR does
  • Explain why the change is necessary
  • Include examples or screenshots if applicable

Pull Request Guidelines

Keep PRs focused: Each PR should address a single issue or feature. Avoid combining multiple unrelated changes.

Write good descriptions: Clearly explain what your PR does, why it's needed, and how it works.

Ensure quality: All code should be tested and documented. PRs with untested changes or massive auto-generated modifications will not be accepted.

Be responsive: Address review feedback promptly and be open to suggestions.

Documentation

Update relevant documentation when making changes:

  • README.md for user-facing changes
  • Docstrings for API changes
  • Comments for complex logic

Questions?

If you have questions about contributing, feel free to:

  • Open an issue for discussion
  • Reach out to maintainers
  • Check existing documentation

Thank you for helping make CodeEvolve better!