You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+5-13Lines changed: 5 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ If you're intending to make significant changes, please raise them in the [Discu
6
6
7
7
Being one of our contributors, you agree and confirm that:
8
8
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**.
10
10
* Your work will be distributed under a BSD 3-Clause License once your pull request is merged.
11
11
* You submitted work fulfils or mostly fulfils our coding conventions, styles and standards.
12
12
@@ -17,30 +17,22 @@ If you're adding or amending UBX payload definitions or configuration database k
17
17
## Coding conventions
18
18
19
19
* 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.
21
21
* 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.
22
22
* Avoid external library dependencies unless there's a compelling reason not to.
23
23
* 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.
24
24
* 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.
28
28
* Commits must be [signed](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits).
29
29
30
30
## Testing
31
31
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
-
34
32
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.
35
33
36
34
Please write unitttest examples for new code you create and add them to the `/tests` folder following the naming convention `test_*.py`.
37
35
38
-
We test on the following platforms using a variety of u-blox devices from Generation 7 throught Generation 10:
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