Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
43 lines (29 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

43 lines (29 loc) · 1.41 KB
Raw

Contributing

Thanks for your interest in the Hubble Gateway SDK Android Quickstart.

This repo is primarily a reference implementation maintained by the Hubble team. We're happy to accept contributions for:

  • Bug fixes
  • Documentation improvements
  • Build/CI improvements
  • Compatibility fixes for new Android versions or build tools

For larger feature changes or architectural shifts, please open an issue first to discuss before writing code.

Reporting bugs

Open a GitHub issue with:

  • What you expected to happen
  • What actually happened
  • Steps to reproduce
  • Your device, Android version, and SDK version (e.g. gateway-sdk:0.2.5)
  • Relevant logs (with sensitive info redacted)

For security vulnerabilities, see SECURITY.md.

Pull requests

  1. Fork the repo and create a feature branch.
  2. Make your changes. Keep them focused: one PR per logical change.
  3. Verify the build passes locally: 
    ./gradlew assembleDebug
./gradlew assembleRelease
  4. Open a PR with a clear description of what changed and why.

SDK changes

The Hubble Gateway SDK itself is a separate, commercial product. Changes to SDK behavior must be made in the SDK repo, not here. This repo only demonstrates SDK usage.

License

By contributing, you agree that your contributions will be licensed under the Apache License, Version 2.0.