Commit graph

10 commits

Author SHA1 Message Date
Jussi Kukkonen
28a031f039 tests: Remove aggregate_tests.py
This was essentially unused now (originally it was used to
randomize the test order).

Signed-off-by: Jussi Kukkonen <jkukkonen@google.com>
2024-12-11 10:11:49 +02:00
Kapil Sharma
292fb0f774
Updating Contributing guidelines and copy-pastable code (#2642)
* Make commands easier to copy

Signed-off-by: h4l0gen <ks3913688@gmail.com>
Signed-off-by: Kapil Sharma <ks3913688@gmail.com>
2024-06-04 09:33:49 +03:00
Jussi Kukkonen
10841c6a23 tox: Add auto-format and and auto-fix
"tox -e fix" will fix whatever ruff knows how to fix automatically.

Signed-off-by: Jussi Kukkonen <jkukkonen@google.com>
2024-03-07 12:01:03 +02:00
Jussi Kukkonen
f82e0bb88d docs: Incorporate review suggestions
Signed-off-by: Jussi Kukkonen <jkukkonen@google.com>
2024-02-29 15:54:18 +02:00
Jussi Kukkonen
1b03ac240e docs: Improve CONTRIBUTING
* Remove outdated info on linters
* Move DCO info to the top: no-one will find it in the bottom

Signed-off-by: Jussi Kukkonen <jkukkonen@google.com>
2024-02-27 16:38:29 +02:00
Lukas Puehringer
cd70e47d14 doc: cross-doc absolute link hack
This is an ugly hack to also resolve the link when the document is
rendered in GitHub, where it is likely to be browsed, because it is
the community standard location for a GitHub repo's contributing
docs.

Coordinate with #1849 to better separate RTD docs with GitHub docs
in the future.

Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
2022-02-10 10:10:20 +01:00
Lukas Puehringer
c40bb3092b doc: fix link to tox docs
Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
2022-02-09 17:56:35 +01:00
Lukas Puehringer
0b2b1bbe0e doc: minor title changes for rtd navbar
Make contributing document header sentence case for consistency
with other docs and shorten menu name in side navbar to stand out
less.

Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
2022-02-09 17:56:35 +01:00
Lukas Puehringer
43439316b8 doc: update install section in contributing doc
Replace custom installation section in contribution docs with
pointer to updated installation documentation.

Also configure sphinx autosectionlabel for cross-document refs.

Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
2022-02-09 17:56:35 +01:00
Lukas Puehringer
4d1fad233a doc: rename contribution instructions
Rename CONTRIBUTORS.rst -> CONTRIBUTING.rst. The new name is what
GitHub expects and will make the document more discoverable, e.g.
on https://github.com/theupdateframework/python-tuf/contribute.

More details under:
https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors

Note: I searched all repositories in theupdateframework GitHub
organization for references (there were none) and will update the
links in the CII Best Practice badge app for tuf.

Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
2022-02-09 15:08:45 +01:00
Renamed from docs/CONTRIBUTORS.rst (Browse further)