Skip to content

Latest commit

 

History

History
57 lines (37 loc) · 3.86 KB

CONTRIBUTING.md

File metadata and controls

57 lines (37 loc) · 3.86 KB
Raw

pynmeagps How to contribute

pynmeagps is a volunteer project and we appreciate any contribution, from fixing a grammar mistake in a comment to extending device test coverage or implementing new functionality. Please read this section if you are contributing your work.

If you're intending to make significant changes, please raise them in the Discussions Channel beforehand.

Being one of our contributors, you agree and confirm that:

  • The work is all your own.
  • Your work will be distributed under a BSD 3-Clause License once your pull request is merged.
  • You submitted work fulfils or mostly fulfils our coding conventions, styles and standards.

Please help us keep our issue list small by adding fixes: #{$ISSUE_NO} to the commit message of pull requests that resolve open issues. GitHub will use this tag to auto close the issue when the PR is merged.

Coding conventions

  • This is open source software. Code should be as simple and transparent as possible. Favour clarity over brevity.
  • The code should be compatible with Python >= 3.9.
  • The core code should be as generic and reusable as possible. We endeavour to limit the amount of processing dedicated to specific UBX message types, though this is sometimes unavoidable.
  • Avoid external library dependencies unless there's a compelling reason not to.
  • We use and recommend Visual Studio Code with the Python Extension for development and testing.
  • Code should be documented in accordance with Sphinx docstring conventions.
  • Code should formatted using black (>= 24.4).
  • We use and recommend pylint (>=3.0.1) for code analysis.
  • We use and recommend bandit (>=1.7.5) for security vulnerability analysis.
  • Commits must be signed.

Testing

While we endeavour to test on as wide a variety of u-blox devices as possible, as a volunteer project we only have a limited number of devices available. We particularly welcome testing contributions relating to specialised devices (e.g. high precision HP, real-time kinematics RTK, automotive dead-reckoning ADR, etc.).

We use python's native pytest framework for local unit testing, complemented by the GitHub Actions automated build and testing workflow. We endeavour to have 100% code coverage.

Please write pytest examples for new code you create and add them to the /tests folder following the naming convention test_*.py.

We test on the following platforms using a variety of u-blox devices from Generation 7 throught Generation 10:

  • Windows 11
  • MacOS (Ventura & Sonoma, Intel & Apple Silicon)
  • Linux (Ubuntu 22.04 LTS Jammy Jellyfish, 24.04 LTS Noble Numbat)
  • Raspberry Pi OS (32-bit & 64-bit)

Submitting changes

Please send a GitHub Pull Request to pynmeagps with a clear list of what you've done (read more about pull requests). Please follow our coding conventions (above) and make sure all of your commits are atomic (one feature per commit).

Please sign all commits - see Signing GitHub Commits for instructions.

Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:

$ git commit -m "A brief summary of the commit
> 
> A paragraph describing what changed and its impact."

Thanks,

semuadmin