You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/maintainers_guide.md
+36-14Lines changed: 36 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,7 +40,7 @@ $ pyenv rehash
40
40
41
41
Then, you can create a new [Virtual Environment](https://docs.python.org/3/tutorial/venv.html) specific to the Python version you just installed by running:
42
42
43
-
```
43
+
```bash
44
44
$ python -m venv env_3.9.6
45
45
$ source env_3.9.6/bin/activate
46
46
```
@@ -53,22 +53,33 @@ do so after you are done working in this project. To come back to development
53
53
work for this project again in the future, `cd` into this project directory and
54
54
run `source env_3.9.6/bin/activate` again.
55
55
56
-
The last step is to install this project's dependencies; to do so, check out [how
57
-
we configure GitHub Actions to install dependencies for this project for use in
58
-
our continuous integration](https://github.com/slackapi/python-slack-sdk/blob/main/.github/workflows/ci-build.yml#L26-L30). You can also run `./scripts/run_validation.sh` to install the dependencies and run the unit tests in one command!
56
+
The last step is to install this project's dependencies and run all unit tests; to do so, you can run
57
+
```bash
58
+
$ ./scripts/run_validation.sh
59
+
```
59
60
61
+
Also check out [how
62
+
we configure GitHub Actions to install dependencies for this project for use in
When you make changes to this SDK, please write unit tests verifying if the changes work as you expected. You can easily run all the tests by running the command. The `validate` command runs Flake8 (static code analyzer), Black (code formatter), and unit tests in the `tests` directory for you.
68
+
When you make changes to this SDK, please write unit tests verifying if the changes work as you expected. You can easily run all the tests and formatting/linter with the below scripts.
69
+
70
+
Run all the unit tests, code formatter, and code analyzer:
71
+
```bash
72
+
$ ./scripts/run_validation.sh
73
+
```
65
74
75
+
Run all the unit tests (no formatter nor code analyzer):
You can rely on GitHub Actions builds for running the tests on a variety of Python runtimes.
@@ -77,20 +88,31 @@ You can rely on GitHub Actions builds for running the tests on a variety of Pyth
77
88
78
89
This project also has integration tests that verify the SDK works with the Slack API platform. As a preparation, you need to set [the required env variables](https://github.com/slackapi/python-slack-sdk/blob/main/integration_tests/env_variable_names.py) properly. You don't need to setup all of them if you just want to run some of the tests. Commonly, `SLACK_SDK_TEST_BOT_TOKEN` and `SLACK_SDK_TEST_USER_TOKEN` are used for running `WebClient` tests.
0 commit comments