Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (33 loc) · 1.53 KB

CONTRIBUTING.md

File metadata and controls

44 lines (33 loc) · 1.53 KB
Raw

🤝 Contributing to BetterTether

We're so glad you're interested in helping BetterTether! This project is built by the community, for the community. Here's a quick guide into how you can contribute:

1. Report a Bug 🐛

If you find a bug, please open an issue with as much information as possible:

  • Your macOS version and device model.
  • Your Android device model and OS version.
  • Relevant logs from /var/log/bettertether.log.

⚠️ Important: For security vulnerabilities, please do NOT open a public issue. See our Security Policy for private reporting instructions.

2. Suggest a Feature ✨

Have an idea for v1.0? Please open a feature request issue! We're particularly interested in testing with more Android device manufacturers.

3. Submit a Pull Request 🛠️

To contribute code:

  1. Fork the repository and create your own branch.
  2. Add tests for any new features or bug fixes.
  3. Ensure all tests pass by running make test.
  4. Format your code with make fmt.
  5. Submit a Pull Request with a clear description of your changes.

4. Code Standards 📏

  • Follow the standard Go structure.
  • Keep functions small and well-documented.
  • Avoid adding external dependencies unless absolutely necessary.

Verifying Tests Locally:

To run clinical unit tests:

make test

To run a race condition check:

make test-race

Thank you for making BetterTether better for everyone! 🚀