Skip to content

Commit 2c5565a

Browse files
authored
Merge pull request #1296 from tableau/update-dev-notes
Update dev guide to be clarify installing dependencies, running tests, black and mypy
2 parents 906b86c + bafccd4 commit 2c5565a

1 file changed

Lines changed: 8 additions & 3 deletions

File tree

docs/dev-guide.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,15 @@ add your contributions to the **development** branch.
3030

3131
```shell
3232
git clone git@github.com:<user-name>/server-client-python.git
33+
cd server-client-python
3334
```
3435

35-
1. Run the tests to make sure everything is passing:
36+
1. Install dependencies and run the tests to make sure everything is passing:
3637

3738
```shell
38-
python setup.py test
39+
python -m pip install --upgrade pip
40+
pip install -e .[test] build
41+
pytest test
3942
```
4043

4144
1. Configure a remote that points to the source (upstream) repository:
@@ -61,7 +64,7 @@ For documentation changes, see the documentation section below.
6164
### Code and commit
6265

6366
Here's a quick checklist to follow when coding to ensure a good pull request
64-
(PR):
67+
(PR) that will pass the PR checks:
6568

6669
- Only touch the fewest number of files possible while still accomplishing the
6770
goal.
@@ -71,6 +74,8 @@ Here's a quick checklist to follow when coding to ensure a good pull request
7174
`black --line-length 120 tableauserverclient samples test` to catch and fix any style
7275
issues before submitting your pull request. (Run black with the `--check` option if
7376
you want to check whether formatting is valid without changing any files.)
77+
- Ensure the Mypy static type checker is still passing by running
78+
`mypy --show-error-codes --disable-error-code misc --disable-error-code import tableauserverclient test`.
7479
- Keep commit messages clean and descriptive.
7580

7681
### Use git pre-commit hook

0 commit comments

Comments
 (0)