Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
34 lines (22 loc) · 1.03 KB

CONTRIBUTING.md

File metadata and controls

34 lines (22 loc) · 1.03 KB

Contributing to Relvio

Thanks for your interest in contributing! Here's how you can help.

Reporting Bugs

Open an issue on GitHub Issues with:

  • A clear title describing the problem
  • Steps to reproduce the issue
  • What you expected to happen vs. what actually happened
  • Your OS and Python version

Requesting Features

Open a GitHub issue with the feature request label. Describe the use case and why it would be valuable.

Submitting a Pull Request

  1. Fork the repository
  2. Create a branch from main (git checkout -b my-fix)
  3. Make your changes and test them locally
  4. Commit with a clear message describing what changed and why
  5. Push to your fork and open a Pull Request against main

Every PR should include:

  • A clear description of what changed and why
  • Confirmation that the app runs correctly with make install && make run

Code Style

  • Keep it simple — match the style of the existing codebase
  • No new dependencies without a good reason