8000 Update CONTRIBUTING.md for DCO, test, and lint (#326) · SysOfM/client_python@687c601 · GitHub
[go: up one dir, main page]
Skip to content

Commit 687c601

Browse files
bz2brian-brazil
bz2
authored and
brian-brazil
committed
Update CONTRIBUTING.md for DCO, test, and lint (prometheus#326)
Mention the DCO signing requirement and link wiki page with details. Add section on testing requirements and tools. Add section on code style and lint details. Signed-off-by: Martin Packman <martin@zegami.com>
1 parent 428cf1b commit 687c601

File tree

1 file changed

+34
-4
lines changed

1 file changed

+34
-4
lines changed

‎CONTRIBUTING.md

Lines changed: 34 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,37 @@ Prometheus uses GitHub to manage reviews of pull requests.
66
addressing (with `@...`) the maintainer of this repository (see
77
[MAINTAINERS.md](MAINTAINERS.md)) in the description of the pull request.
88

9-
* If you plan to do something more involved, first discuss your ideas
10-
on our [mailing list](https://groups.google.com/forum/?fromgroups#!forum/prometheus-developers).
11-
This will avoid unnecessary work and surely give you and us a good deal
12-
of inspiration.
9+
* If you plan to do something more involved, first discuss your ideas on
10+
[our mailing list]. This will avoid unnecessary work and surely give you and
11+
us a good deal of inspiration.
12+
13+
* Before your contributions can be landed, they must be signed off under the
14+
[Developer Certificate of Origin] which asserts you own and have the right to
15+
submit the change under the open source licence used by the project.
16+
17+
## Testing
18+
19+
Submitted changes should pass the current tests, and be covered by new test
20+
cases when adding functionality.
21+
22+
* Run the tests locally using [tox] which executes the full suite on all
23+
supported Python versions installed.
24+
25+
* Each pull request is gated using [Travis CI] with the results linked on the
26+
github page. This must pass before the change can land, note pushing a new
27+
change will trigger a retest.
28+
29+
## Style
30+
31+
* Code style should follow [PEP 8] generally, and can be checked by running:
32+
``tox -e flake8``.
33+
34+
* Import statements can be automatically formatted using [isort].
35+
36+
37+
[our mailing list]: https://groups.google.com/forum/?fromgroups#!forum/prometheus-developers
38+
[Developer Certificate of Origin]: https://github.com/prometheus/prometheus/wiki/DCO-signing
39+
[isort]: https://pypi.org/project/isort/
40+
[PEP 8]: https://www.python.org/dev/peps/pep-0008/
41+
[tox]: https://tox.readthedocs.io/en/latest/
42+
[Travis CI]: https://docs.travis-ci.com/

0 commit comments

Comments
 (0)
0