diff --git a/_includes/header.html b/_includes/header.html index b8ad08f65..1981675d9 100644 --- a/_includes/header.html +++ b/_includes/header.html @@ -19,7 +19,7 @@
diff --git a/docs/dev-guide.md b/docs/dev-guide.md index 3b3c6b862..f190b40c5 100644 --- a/docs/dev-guide.md +++ b/docs/dev-guide.md @@ -21,7 +21,7 @@ add your contributions to the **development** branch. ### Get the source code and set up your branch 1. Fork the repository. We follow the "Fork and Pull" model as described - [here](https://help.github.com/articles/about-collaborative-development-models/). + [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models#fork-and-pull-model). 1. Clone your fork: @@ -42,7 +42,7 @@ add your contributions to the **development** branch. ```shell git remote add upstream https://github.com/tableau/server-client-python ``` - More information about configuring a remote for a fork can be found [here](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/configuring-a-remote-for-a-fork). + More information about configuring a remote for a fork can be found [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/configuring-a-remote-repository-for-a-fork). 1. Sync your fork: ```shell @@ -145,7 +145,7 @@ depending on how and where git is installed on your system, for example: ### Add tests All of our tests live under the `test/` folder in the repository. We use -`pytest` and the built-in test runner `python setup.py test`. +`pytest` to run the tests. Follow the structure of existing tests, especially if new server responses are going to be mocked. @@ -155,6 +155,13 @@ static file, like a .twb/.twbx/.xml, it should live under `test/assets/` Make sure that all tests are passing before submitting your pull request. +| Test | Command | +| --- | --- | +| Test everything | `pytest test` | +| Test everything, run in parallel | `pytest -n auto test` | +| Run a specific test | `pytest test/test_user.py` | +| Code coverage report | `pip install coverage`