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
+4-14Lines changed: 4 additions & 14 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 styles and standards.
12
12
@@ -15,30 +15,20 @@ Please help us keep our issue list small by adding fixes: #{$ISSUE_NO} to the co
15
15
## Coding conventions
16
16
17
17
* This is open source software. Code should be as simple and transparent as possible. Favour clarity over brevity.
18
-
* The code should be compatible with Python >= 3.9 and tkinter >= 8.6.
19
18
* Avoid external library dependencies unless there's a compelling reason not to.
20
19
* 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.
21
20
* Code should be documented in accordance with [Sphinx](https://www.sphinx-doc.org/en/master/) docstring conventions.
22
-
* Code should formatted using [black](https://pypi.org/project/black/) (>= 25.0.0).
23
-
* We use and recommend [pylint](https://pypi.org/project/pylint/)(>= 3.3.0) for code analysis.
24
-
* We use and recommend [bandit](https://pypi.org/project/bandit/)(>= 1.8.0) for security vulnerability analysis.
21
+
* Code should formatted using [black](https://pypi.org/project/black/).
22
+
* We use and recommend [pylint](https://pypi.org/project/pylint/) for code analysis.
23
+
* We use and recommend [bandit](https://pypi.org/project/bandit/) for security vulnerability analysis.
25
24
* Commits must be [signed](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits).
26
25
27
26
## Testing
28
27
29
-
While we endeavour to test on as wide a variety of u-blox devices and host platforms 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.).
30
-
31
28
We use Python's native unittest framework for local unit testing, complemented by the GitHub Actions automated build and testing workflow.
32
29
33
30
Please write unittest examples for new code you create and add them to the `/tests` folder following the naming convention `test_*.py`.
34
31
35
-
We test on the following host platforms using a variety of GNSS devices:
36
-
37
-
* Windows 11 (Intel and Snapdragon)
38
-
* MacOS (Sonoma & Sequoia, Intel and Apple Silicon)
39
-
* Linux (Ubuntu 24.04 LTS Numbat & 25.02 Puffin)
40
-
* Raspberry Pi OS (Bookworm 32-bit & 64-bit)
41
-
42
32
## Submitting changes
43
33
44
34
Please send a [GitHub Pull Request to PyGPSClient](https://github.com/semuconsulting/PyGPSClient/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 (below) and make sure all of your commits are atomic (one feature per commit).
Copy file name to clipboardExpand all lines: INSTALLATION.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -61,7 +61,7 @@ The exact location of the site_packages and binary directories will depend on th
61
61
62
62
In the following, `python3` & `pip` refer to the Python 3 executables. You may need to substitute `python` for `python3`, depending on your particular environment (*on Windows it's generally `python`*).
63
63
64
-
- Python >= 3.9⁴
64
+
- Python >= 3.10⁴
65
65
- Tk (tkinter) >= 8.6⁵ (*tkinter is a commonly used library for developing Graphical User Interfaces (GUI) in Python*)
66
66
- Screen resolution >= 640 x 400; Ideally 1920 x 1080, though at lower screen resolutions (<= 1024 width), top level dialogs will be resizable and scrollable.
67
67
@@ -239,7 +239,7 @@ TBC. Anyone conversant with PowerShell is welcome to contribute an equivalent in
0 commit comments