openrabbit/CONTRIBUTING.md

Contributing to ${REPO_NAME}

Thank you for your interest in contributing! Here's how to get started.

Getting Started

1. Fork this repository on git.hiddenden.cafe.
2. Clone your fork locally.
3. Create a feature branch: git checkout -b feature/my-change
4. Make your changes and commit with clear messages.
5. Push to your fork and open a Pull Request.

Development

# Install dependencies
pip install -r requirements.txt  # Python
npm ci                           # Node (if applicable)

# Run checks locally before pushing
make fmt
make lint
make test

Pull Request Guidelines

• Fill out the PR template completely.
• Keep PRs focused — one logical change per PR.
• Ensure CI passes (lint + tests).
• Update documentation if your change affects behavior.

Code Style

• Python: Follow PEP 8. We use ruff for linting and black for formatting.
• JavaScript/TypeScript: Follow the project's ESLint config if present.
• Use .editorconfig settings (your editor should pick them up automatically).

Reporting Issues

Use the issue templates provided:

• Bug Report — for defects
• Feature Request — for new ideas
• Question / Support — for help

For security issues, see SECURITY.md.

Code of Conduct

Please read and follow our Code of Conduct.