Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (33 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

51 lines (33 loc) · 1.73 KB

Contributing to WattSeal

Thanks for your interest in contributing to WattSeal! This is our first open-source project, so we're learning along with you. Every contribution — big or small — is appreciated.

How to Contribute

Reporting Bugs

If you find a bug, please open an issue with:

  • A clear description of the problem
  • Steps to reproduce it
  • Your OS and whether you ran with admin/root privileges
  • Any relevant error output

Suggesting Features

Got an idea? Open a feature request and describe what you'd like to see and why it would be useful.

Submitting Code

  1. Fork the repository and create a branch from main
  2. Make your changes — keep them focused on a single issue or feature
  3. Format your code with cargo +nightly fmt
  4. Test that the project builds: cargo build
  5. Open a Pull Request with a clear description of what you changed and why

Contributor License Agreement

By submitting a pull request or any other contribution to this repository, you agree to the terms of the Contributor License Agreement.

Development Setup

git clone https://github.com/Daminoup88/WattSeal.git
cd wattseal
cargo build

See the Developer documentation for detailed build instructions and architecture overview.

Code Style

  • Run cargo +nightly fmt before committing
  • Follow the existing code conventions you see in the project
  • Keep changes minimal and focused

Questions?

If you're unsure about anything, feel free to open an issue and ask. We're happy to help!