Contributing to Nexus N3

Thank you for your interest in contributing to Nexus N3.

The public Nexus N3 repositories provide tools for working with the Nexus N3 BLE Gateway, integrating sensors, and developing Nexus N3 plugins.

Before contributing

For substantial changes, please open an issue first describing:

• the problem you want to solve
• your proposed approach
• any relevant hardware, sensor, algorithm, or compatibility considerations

Small bug fixes and documentation improvements may be submitted directly as pull requests.

Development workflow

1. Fork the relevant repository.
2. Create a branch from main.
3. Make and test your changes.
4. Update documentation when behaviour changes.
5. Submit a focused pull request.

Avoid combining unrelated changes in one pull request.

Pull requests

Please include:

• a clear explanation of the change
• why the change is needed
• instructions for testing it
• relevant operating system, Python, gateway, sensor, or hardware details
• links to related issues

Ensure existing tests pass where applicable.

Reporting bugs

Please include:

• repository and package version
• operating system and Python version
• relevant gateway or sensor hardware
• steps to reproduce the issue
• expected behaviour
• actual behaviour
• relevant logs or error messages

Do not include credentials, access tokens, private keys, personal data, or other sensitive information.

Plugin contributions

Public plugins contributed to Nexus N3 repositories should include:

• source code
• installation or build instructions
• a clear open-source licence
• plugin compatibility information
• tests where practical

Private plugins do not need to be submitted to the public Nexus N3 repositories.

Licence

By submitting a contribution to a Nexus N3 repository, you agree that your contribution will be licensed under the licence used by that repository.