8000 doc: Extend CONTRIBUTING.md with more info on running tests · lmasikl/sentry-python@464ca8d · GitHub
[go: up one dir, main page]

Skip to content

Commit 464ca8d

Browse files
committed
doc: Extend CONTRIBUTING.md with more info on running tests
1 parent 47e3670 commit 464ca8d

File tree

2 files changed

+21
-2
lines changed

2 files changed

+21
-2
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,23 @@ The public-facing channels for support and development of Sentry SDKs can be fou
1313
Make sure you have `virtualenv` installed, and the Python versions you care
1414
about. You should have Python 2.7 and the latest Python 3 installed.
1515

16-
You don't need to `workon` or `activate` anything, the `Makefile` will create
17-
one for you. Run `make` or `make help` to list commands.
16+
We have a `Makefile` that is supposed to help people get started with hacking
17+
on the SDK without having to know or understand the Python ecosystem. You don't
18+
need to `workon` or `bin/activate` anything, the `Makefile` will do everything
19+
for you. Run `make` or `make help` to list commands.
20+
21+
Of course you can always run the underlying commands yourself, which is
22+
particularly useful when wanting to provide arguments to `pytest` to run
23+
specific tests. If you want to do that, we expect you to know your way around
24+
Python development, and you can run the following to get started with `pytest`:
25+
26+
# This is "advanced mode". Use `make help` if you have no clue what's
27+
# happening here!
28+
29+
pip install -e .
30+
pip install -r test-requirements.txt
31+
32+
pytest tests/
1833

1934
## Releasing a new version
2035

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,10 @@ To learn about internals:
3737

3838
- [API Reference](https://getsentry.github.io/sentry-python/)
3939

40+
# Contributing to the SDK
41+
42+
Please refer to [CONTRIBUTING.md](./CONTRIBUTING.md).
43+
4044
# License
4145

4246
Licensed under the BSD license, see `LICENSE`

0 commit comments

Comments
 (0)
0