Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
61 lines (42 loc) · 2.38 KB

CONTRIBUTING.md

File metadata and controls

61 lines (42 loc) · 2.38 KB

Contributing to R2R

Thank you for your interest in contributing to R2R! We welcome contributions from the community to help improve and expand the capabilities of this project.

Ways to Contribute

There are several ways you can contribute to R2R:

  • Reporting bugs and issues
  • Suggesting new features or improvements
  • Submitting pull requests to fix bugs or implement new features
  • Improving documentation
  • Providing feedback and suggestions

Getting Started

To get started with contributing to R2R, follow these steps:

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your contribution.
  4. Make your changes and commit them with descriptive commit messages.
  5. Push your changes to your forked repository.
  6. Submit a pull request to the main R2R repository.

Development Setup

To set up the development environment for R2R, please refer to the installation instructions in the README file.

Code Style and Guidelines

  • Follow the existing code style and conventions used in the project.
  • Write clear, concise, and well-documented code.
  • Include appropriate tests for your changes.
  • Update the documentation if necessary.

Pull Request Process

  1. Ensure that your pull request addresses a single issue or feature.
  2. Provide a clear and descriptive title for your pull request.
  3. Include a detailed description of the changes made and the problem they solve.
  4. Make sure that your changes pass all existing tests and add new tests if required.
  5. Keep your pull request focused and avoid including unrelated changes.
  6. Be responsive to feedback and engage in the discussion related to your pull request.

Reporting Issues

If you encounter any bugs, issues, or have suggestions for improvements, please open an issue on the GitHub repository. When reporting an issue, please provide as much detail as possible, including:

  • A clear and descriptive title
  • Steps to reproduce the issue
  • Expected behavior
  • Actual behavior
  • Screenshots or error messages (if applicable)
  • Environment details (OS, Python version, etc.)

Contact

If you have any questions or need further assistance, feel free to reach out to the project maintainers on the Discord server.

Thank you for your contributions to R2R!