CONTRIBUTING.md

Contributing to rxml

Thanks for your interest in contributing to rxml! This document provides guidelines and instructions for contributing.

Getting Started

Prerequisites

• Python 3.10+
• A stable Rust toolchain
• Maturin (pip install maturin)

Development Setup

1. Fork and clone the repository:

   git clone https://github.com/<your-username>/rxml.git
   cd rxml

2. Create and activate a virtual environment:

   python -m venv .venv
   source .venv/bin/activate   # Linux/macOS
   .venv\Scripts\activate      # Windows

3. Install development dependencies:

   pip install maturin

4. Build the project in development mode:

   maturin develop

5. Run the tests:

   cargo test

Making Changes

1. Create a new branch for your feature or fix:

   git checkout -b feature/your-feature-name

2. Make your changes. If you're modifying Rust code, rebuild with maturin develop before testing.

3. Ensure all tests pass:

   cargo test

4. Format your code:

   cargo fmt

5. Run the Rust linter:

   cargo clippy

Submitting a Pull Request

1. Push your branch to your fork.
2. Open a pull request against the main branch.
3. Provide a clear description of your changes and the motivation behind them.
4. Ensure CI checks pass.

Reporting Issues

If you encounter a bug or have a feature request, please open an issue with as much detail as possible, including:

• Your Python and Rust versions
• Your operating system
• A minimal reproducible example (if applicable)

Code of Conduct

Please be respectful and constructive in all interactions. We are committed to providing a welcoming and inclusive experience for everyone.