1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
Contributing
============
Getting Involved
----------------
So you'd like to contribute? That's awesome! We would love to have your help,
especially in the following ways:
* Making Pull Requests for code, tests, or docs
* Commenting on open issues and pull requests
* Suggesting new features
Setting Up Your Environment
---------------------------
Fork the repository and clone your fork to your local machine:
.. code-block:: bash
git clone https://github.com/yourusername/fastkml.git
cd fastkml
git checkout develop
Next, set up a virtual environment. This helps to manage dependencies and avoid conflicts:
.. code-block:: bash
python3 -m venv .venv
source venv/bin/activate # On Windows use `venv\Scripts\activate`
Then, install the required packages:
.. code-block:: bash
pip install -e ".[dev]"
Install the ``pre-commit`` hook with:
.. code-block:: bash
pre-commit install
and check the code with:
.. code-block:: bash
pre-commit run --all-files
Running the Tests
-----------------
To run the tests, simply use:
.. code-block:: bash
pytest
You can also run the tests with `coverage <https://coverage.readthedocs.io/>`_
to see which lines are covered by the tests.
This is useful for writing new tests to cover any uncovered lines:
.. code-block:: bash
pytest --cov=fastkml --cov-report=term
To get a report on the individual lines that are not covered, use the
``--cov-report=term-missing`` option, or generate an HTML report with
``--cov-report=html``.
Some editor extensions can also show the coverage directly in the editor, notably
`coverage-gutter <https://marketplace.visualstudio.com/items?itemName=ryanluker.vscode-coverage-gutters>`_
for VSCode, which needs the output to be in the ``xml`` format produced with
``--cov-report=xml``.
Tips
----
- Commit often, commit early.
- Make a draft PR while you are still working on it to give your work some visibility.
|
