Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (40 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

54 lines (40 loc) · 1.46 KB
Raw

Contributing

Thank you for your interest in contributing! We appreciate all contributions, from bug reports to feature requests and code improvements.

How to Contribute

Reporting Bugs

  • Check existing issues first to avoid duplicates
  • Open a new issue with a clear title and description
  • Include steps to reproduce, expected vs actual behavior, and environment details

Suggesting Features

  • Open an issue with the enhancement label
  • Describe the feature and explain why it would be valuable

Submitting Code

  1. Fork this repository
  2. Create a branch from main: 
    git checkout -b feature/your-feature-name
  3. Make your changes and add tests if applicable
  4. Commit with a clear message: 
    git commit -m "feat: add your feature description"
  5. Push to your fork and open a Pull Request

Guidelines

  • Follow the existing code style and conventions
  • Keep PRs focused on a single concern
  • Write clear commit messages
  • Update documentation when changing behavior
  • Be respectful and constructive in all interactions (see Code of Conduct)

Development Setup

# Clone your fork
git clone https://github.com/YOUR_USERNAME/REPO_NAME.git
cd REPO_NAME

# Install dependencies (see README for details)

Questions?

Open an issue or start a discussion — we're happy to help!

Documentation contributed by Mukller