Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
33 lines (24 loc) · 1.48 KB

CONTRIBUTING.md

File metadata and controls

33 lines (24 loc) · 1.48 KB

Contributing to VoidMic

First off, thank you for considering contributing to VoidMic! It's people like you that make the open-source community such a great place.

How Can I Help?

Reporting Bugs

  • Use the Bug Report Template.
  • Describe the bug and provide steps to reproduce it.
  • Include your Linux distribution and audio setup (PipeWire/PulseAudio).

Suggesting Enhancements

  • Open a Feature Request.
  • Explain why this feature would be useful for gaming or general noise reduction.

Pull Requests

  • Fork the repo and create your branch from master.
  • Ensure your code follows idiomatic Rust patterns.
  • Run cargo fmt and cargo clippy before committing.
  • Open a PR and fill out the checklist in the template.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

AI Disclosure

VoidMic was initially architected and prototyped with the assistance of Google Gemini. We welcome both human-written and AI-assisted contributions, provided they:

  1. Adhere to the project's performance goals (<1% CPU usage).
  2. Are clearly documented and tested.
  3. Maintain the minimalist, CLI-first philosophy.

License

By contributing, you agree that your contributions will be licensed under the MIT License.