Skip to content

Commit df2c371

Browse files
committed
update contributing
1 parent 64a005c commit df2c371

File tree

1 file changed

+5
-13
lines changed

1 file changed

+5
-13
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ If you're intending to make significant changes, please raise them in the [Discu
66

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

9-
* The work is all your own.
9+
* The work is all your own. For the avoidance of doubt, this means **no AI coding agents such as Copilot**.
1010
* Your work will be distributed under a BSD 3-Clause License once your pull request is merged.
1111
* You submitted work fulfils or mostly fulfils our coding conventions, styles and standards.
1212

@@ -17,30 +17,22 @@ If you're adding or amending UBX payload definitions or configuration database k
1717
## Coding conventions
1818

1919
* This is open source software. Code should be as simple and transparent as possible. Favour clarity over brevity.
20-
* The code should be compatible with Python >= 3.9.
20+
* The code should be compatible with Python >= 3.10.
2121
* 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.
2222
* Avoid external library dependencies unless there's a compelling reason not to.
2323
* We use and recommend [Visual Studio Code](https://code.visualstudio.com/) with the [Python Extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) for development and testing.
2424
* Code should be documented in accordance with [Sphinx](https://www.sphinx-doc.org/en/master/) docstring conventions.
25-
* Code should formatted using [black](https://pypi.org/project/black/) (>= 24.4).
26-
* We use and recommend [pylint](https://pypi.org/project/pylint/) (>=3.0.1) for code analysis.
27-
* We use and recommend [bandit](https://pypi.org/project/bandit/) (>=1.7.5) for security vulnerability analysis.
25+
* Code should formatted using [black](https://pypi.org/project/black/).
26+
* We use and recommend [pylint](https://pypi.org/project/pylint/) for code analysis.
27+
* We use and recommend [bandit](https://pypi.org/project/bandit/) for security vulnerability analysis.
2828
* Commits must be [signed](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits).
2929

3030
## Testing
3131

32-
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.).
33-
3432
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 >99% code coverage.
3533

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

38-
We test on the following platforms using a variety of u-blox devices from Generation 7 throught Generation 10:
39-
* Windows 11
40-
* MacOS (Intel & Apple Silicon)
41-
* Linux (Ubuntu 22.04 LTS Jammy Jellyfish, 24.04 LTS Noble Numbat)
42-
* Raspberry Pi OS (32-bit & 64-bit)
43-
4436
## Submitting changes
4537

4638
Please send a [GitHub Pull Request to pyubx2](https://github.com/semuconsulting/pyubx2/pulls) with a clear list of what you've done (read more about [pull requests](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/about-pull-requests)). Please follow our coding conventions (above) and make sure all of your commits are atomic (one feature per commit).

0 commit comments

Comments
 (0)