Skip to content

Latest commit

 

History

History
50 lines (31 loc) · 3.03 KB

CONTRIBUTING.md

File metadata and controls

50 lines (31 loc) · 3.03 KB
Raw

How to contribute

pyubx2 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.

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 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. We endeavour to make the code as transparent as possible.
  • We endeavour to keep the core code as generic and reusable as possible, and limit the amount of exceptional processing dedicated to specific UBX message types (though this is sometimes unavoidable).
  • We use Eclipse PyDev for development and testing, but you are at liberty to use your preferred IDE.
  • We use pylint (>=2.6.0) for code analysis.
  • We use black (>= 20.8) for code formatting and ask that you do the same.

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 unittest framework for local unit testing, complemented by the GitHub Actions automated build and testing workflow. We endeavour to have 100% code coverage.

Please write unittest 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 u-blox NEO-6, NEO-7, NEO-8 and NEO-9 devices:

  • Windows 10
  • MacOS (Big Sur)
  • Linux (Ubuntu Bionic)
  • Raspberry Pi OS (32-bit)

Submitting changes

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

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