Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
56 lines (37 loc) · 1.92 KB

CONTRIBUTING.md

File metadata and controls

56 lines (37 loc) · 1.92 KB

Contributing to Reedy

Thank you for considering contributing to Reedy! This document outlines the process for contributing to the project.

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/your-username/reedy.git
  3. Create a new branch for your changes: git checkout -b feature/your-feature-name

Development Environment

  1. Make sure you have Rust installed. We recommend using rustup to manage your Rust installation.
  2. Install dependencies with cargo build
  3. Run the project with cargo run

Making Changes

  1. Make your changes to the codebase
  2. Run tests to ensure your changes don't break existing functionality: cargo test
  3. Add or update tests to cover your changes
  4. Ensure your code follows our style guidelines by running cargo clippy
  5. Format your code with cargo fmt

Submitting Changes

  1. Commit your changes with a descriptive commit message
  2. Push your branch to your fork
  3. Submit a Pull Request to the main repository
  4. Ensure the PR description clearly describes the problem and solution

Pull Request Process

  1. Update the README.md or relevant documentation with details of changes if applicable
  2. The PR will be reviewed by maintainers, who may ask for changes
  3. Once approved, a maintainer will merge your PR

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.

Reporting Bugs

If you find a bug, please report it by creating an issue in the GitHub repository. Please include:

  1. A clear, descriptive title
  2. Steps to reproduce the issue
  3. Expected behavior
  4. Actual behavior
  5. Any relevant logs or screenshots

Feature Requests

We welcome feature requests. Please create an issue in the GitHub repository with a clear description of the feature and why it would be valuable.

Thank you for contributing to Reedy!