Skip to content

Latest commit

 

History

History
33 lines (23 loc) · 1.98 KB

pull_request_template.md

File metadata and controls

33 lines (23 loc) · 1.98 KB
Raw

pyubx2 Pull Request Template

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context and, where applicable, any u-blox documentation sources you have used. List any dependencies that are required for this change.

Please do NOT submit PRs containing information (e.g. UBX message definitions) which is subject to a u-blox Non-Disclosure Agreement (NDA).

Fixes # (issue)

Testing

Please test all changes, however trivial, against the supplied pytest suite tests/test_*.py. Please describe any test cases you have amended or added to this suite to maintain >= 99% code coverage.

If you're adding new UBX message definitions for Generation 9+ devices, please check for any corresponding configuration database updates (ubxtypes_configdb.py).

  • Test A
  • Test B

Checklist:

  • I agree to abide by the code of conduct (see CODE_OF_CONDUCT.md).
  • My code follows the style guidelines of this project (see CONTRIBUTING.MD).
  • I have performed a self-review of my own code.
  • (if appropriate) I have cited my u-blox documentation source(s).
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • (if appropriate) I have added test cases to the tests/test_*.py unittest suite to maintain >= 99% code coverage.
  • I have tested my code against the full tests/test_*.py unittest suite.
  • My changes generate no new warnings.
  • Any dependent changes have been merged and published in downstream modules.
  • I have signed my commits.
  • I understand and acknowledge that the code will be published under a BSD 3-Clause license.