Skip to content

Latest commit

 

History

History
76 lines (56 loc) · 2.52 KB

CONTRIBUTING.md

File metadata and controls

76 lines (56 loc) · 2.52 KB

Contributing to SWE-bench Verified High Score Project

We welcome contributions to the SWE-bench Verified High Score Project! This document provides guidelines for contributing to the project.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork locally: 
    git clone https://github.com/your-username/swe-bench-verified.git
cd swe-bench-verified
  3. Set up your development environment as described in setup.md.

Making Changes

  1. Create a new branch for your feature or bug fix: 
    git checkout -b feature/your-feature-name
  2. Make your changes, following our coding standards (see below).
  3. Write or update tests as necessary.
  4. Run the test suite to ensure all tests pass.
  5. Commit your changes: 
    git commit -m "Description of your changes"
  6. Push to your fork: 
    git push origin feature/your-feature-name
  7. Submit a pull request from your fork to the main repository.

Coding Standards

  • Follow PEP 8 style guide for Python code.
  • Write clear, self-documenting code with appropriate comments.
  • Maintain consistent naming conventions throughout the project.
  • Keep functions and methods focused and concise.

Testing

  • Write unit tests for new functionality.
  • Ensure all existing tests pass before submitting a pull request.
  • Aim for high test coverage, especially for critical components.

Documentation

  • Update relevant documentation for any changes or new features.
  • Use clear and concise language in comments and documentation.
  • Provide examples where appropriate.

Submitting Pull Requests

  • Provide a clear description of the problem and solution in your PR.
  • Reference any related issues in your PR description.
  • Ensure your PR passes all CI checks.
  • Be responsive to feedback and be prepared to make additional changes if requested.

Reporting Issues

  • Use the GitHub issue tracker to report bugs or suggest features.
  • Provide as much detail as possible, including steps to reproduce for bugs.
  • Check if the issue has already been reported before creating a new one.

Community Guidelines

  • Be respectful and considerate in all interactions.
  • Provide constructive feedback and be open to receiving it.
  • Focus on the best outcomes for the project and the community.

Licensing

By contributing to this project, you agree that your contributions will be licensed under the project's MIT License.

Thank you for contributing to the SWE-bench Verified High Score Project! Your efforts help push the boundaries of AI in software engineering.