Skip to content

Commit 64be4b2

Browse files
committed
Clarify documentation on running Earl reports
1 parent d9fd44f commit 64be4b2

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

CONTRIBUTING.rst

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,10 @@ Code
77
----
88

99
* In general, follow the common `PEP 8 Style Guide`_.
10-
* Try to make the code pass flake8_ checks.
11-
12-
* ``flake8 lib/pyld/jsonld.py``
10+
* Try to make the code pass ruff_ checks.
11+
* ``make lint`` or ``ruff check lib/pyld/*``
12+
* you can also apply automatic fixing and formatting
13+
using ``make fmt``
1314

1415
* Use version X.Y.Z-dev in dev mode.
1516
* Use version X.Y.Z for releases.
@@ -55,10 +56,7 @@ As of early 2020, the process to generate an EARL report for the official
5556
`JSON-LD Processor Conformance`_ page is:
5657

5758
* Run the tests on the ``json-ld-api`` and ``json-ld-framing`` test repos to
58-
generate a ``.jsonld`` test report:
59-
60-
* ``python tests/runtests.py ../json-ld-api/tests/ ../json-ld-framing/tests/ -e pyld-earl.jsonld``
61-
59+
generate a ``.jsonld`` test report as explained in [README.rst](./README.rst#tests)
6260
* Use the rdf_ tool to generate a ``.ttl``:
6361

6462
* ``rdf serialize pyld-earl.jsonld --output-format turtle -o pyld-earl.ttl``
@@ -70,7 +68,7 @@ As of early 2020, the process to generate an EARL report for the official
7068
.. _JSON-LD Processor Conformance: https://w3c.github.io/json-ld-api/reports/
7169
.. _PEP 8 Style Guide: https://www.python.org/dev/peps/pep-0008/
7270
.. _Semantic Versioning: https://semver.org/
73-
.. _flake8: https://pypi.python.org/pypi/flake8
71+
.. _ruff: https://docs.astral.sh/ruff/
7472
.. _json-ld-api repository: https://github.com/w3c/json-ld-api/pulls
7573
.. _rdf: https://rubygems.org/gems/rdf
7674
.. _report instructions: https://github.com/w3c/json-ld-api/tree/master/reports

0 commit comments

Comments
 (0)