Skip to content

Latest commit

 

History

History
57 lines (39 loc) · 1.62 KB

CONTRIBUTING.md

File metadata and controls

57 lines (39 loc) · 1.62 KB

Contributing to LLM Code Review

We welcome contributions to the LLM Code Review 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/llm-code-review.git
  3. Create a new branch for your feature or bug fix: 
    git checkout -b feature/your-feature-name

Making Changes

  1. Make your changes in your feature branch.
  2. Add or update tests as necessary.
  3. Ensure your code follows the project's coding standards.
  4. Run the tests to make sure everything passes.

Submitting Changes

  1. Push your changes to your fork on GitHub: 
    git push origin feature/your-feature-name
  2. Create a pull request from your fork to the main repository.
  3. Provide a clear description of the changes in your pull request.

Code Style

  • Follow PEP 8 guidelines for Python code.
  • Use meaningful variable and function names.
  • Write clear, concise comments and docstrings.

Testing

  • Add tests for new features or bug fixes.
  • Ensure all tests pass before submitting a pull request.

Reporting Issues

  • Use the GitHub issue tracker to report bugs or suggest enhancements.
  • Provide as much detail as possible, including steps to reproduce the issue.

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?

If you have any questions about contributing, please open an issue for discussion.

Thank you for your contributions to LLM Code Review!