Skip to content

Latest commit

 

History

History
64 lines (45 loc) · 1.88 KB

CONTRIBUTING.md

File metadata and controls

64 lines (45 loc) · 1.88 KB

Contributing to MCPR

Thank you for considering contributing to MCPR! This document provides guidelines and instructions for contributing to this project.

Code of Conduct

Please be respectful and considerate of others when contributing to this project. We aim to foster an inclusive and welcoming community.

How to Contribute

  1. Fork the repository - Create your own fork of the project.
  2. Create a branch - Create a branch for your changes.
  3. Make your changes - Implement your changes, following the coding style and guidelines.
  4. Write tests - Add tests for your changes to ensure they work as expected.
  5. Run the tests - Make sure all tests pass.
  6. Submit a pull request - Submit a pull request to the main repository.

Development Setup

  1. Clone the repository:

    git clone https://github.com/conikeec/mcpr.git
cd mcpr

  2. Build the project:

    cargo build

  3. Run the tests:

    cargo test

Coding Style

We follow the standard Rust coding style. Please run cargo fmt before submitting your changes.

Pull Request Process

  1. Ensure your code passes all tests and linting checks.
  2. Update the README.md with details of changes if applicable.
  3. The PR will be merged once it has been reviewed and approved.

Reporting Bugs

If you find a bug, please create an issue on GitHub with the following information:

  • A clear, descriptive title
  • Steps to reproduce the bug
  • Expected behavior
  • Actual behavior
  • Any additional context or screenshots

Feature Requests

If you have a feature request, please create an issue on GitHub with the following information:

  • A clear, descriptive title
  • A detailed description of the proposed feature
  • Any additional context or examples

License

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