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: docs/dev-guide.md
+70-36Lines changed: 70 additions & 36 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,24 +3,30 @@ title: Developer Guide
3
3
layout: docs
4
4
---
5
5
6
-
This topic describes how to contribute to the Tableau Server Client (Python) project.
6
+
This topic describes how to contribute to the Tableau Server Client (Python)
7
+
project.
7
8
8
-
* TOC
9
+
<!-- prettier-ignore -->
10
+
- TOC
9
11
{:toc}
10
12
11
13
---
12
14
13
15
## Submit your first patch
14
16
15
-
This section will get you started with the basic workflow, describing how to create your own fork of the repository and how to open a pull request (PR) to add your contributions to the **development** branch.
17
+
This section will get you started with the basic workflow, describing how to
18
+
create your own fork of the repository and how to open a pull request (PR) to
19
+
add your contributions to the **development** branch.
16
20
17
21
### Get the source code and set up your branch
18
22
19
-
1. Make sure you have [signed the CLA](https://tableau.github.io/contributing.html)
23
+
1. Make sure you have
24
+
[signed the CLA](https://tableau.github.io/contributing.html)
20
25
21
26
1. Fork the repository.
22
27
23
-
We follow the "Fork and Pull" model as described [here](https://help.github.com/articles/about-collaborative-development-models/).
@@ -36,7 +42,8 @@ This section will get you started with the basic workflow, describing how to cre
36
42
37
43
1. Set up the feature, fix, or documentation branch.
38
44
39
-
It is recommended to use the format issue#-type-description (e.g. 13-fix-connection-bug) like so:
45
+
It is recommended to use the format issue#-type-description (e.g.
46
+
13-fix-connection-bug) like so:
40
47
41
48
```shell
42
49
git checkout -b 13-feature-new-stuff development
@@ -46,55 +53,82 @@ This section will get you started with the basic workflow, describing how to cre
46
53
47
54
### Code and commit
48
55
49
-
Here's a quick checklist to follow when coding to ensure a good pull request (PR):
56
+
Here's a quick checklist to follow when coding to ensure a good pull request
57
+
(PR):
50
58
51
-
- Only touch the fewest number of files possible while still accomplishing the goal.
52
-
- Ensure all indentation is done as 4-spaces and your editor is set to unix line endings.
53
-
- The code matches PEP8 style guides. If you cloned the repo you can run `pycodestyle tableauserverclient test samples`
54
-
- Keep commit messages clean and descriptive.
55
-
If the PR is accepted it will get 'Squashed' into a single commit before merging, the commit messages will be used to generate the Merge commit message.
59
+
- Only touch the fewest number of files possible while still accomplishing the
60
+
goal.
61
+
- Ensure all indentation is done as 4-spaces and your editor is set to unix line
62
+
endings.
63
+
- The code matches PEP8 style guides. If you cloned the repo you can run
64
+
`pycodestyle tableauserverclient test samples`
65
+
- Keep commit messages clean and descriptive. If the PR is accepted it will get
66
+
'Squashed' into a single commit before merging, the commit messages will be
67
+
used to generate the Merge commit message.
56
68
57
69
### Add tests
58
70
59
-
All of our tests live under the `test/` folder in the repository.
60
-
We use `pytest` and the built-in test runner `python setup.py test`.
61
-
If a test needs a static file, like a .twb/.twbx, it should live under `test/assets/`
71
+
All of our tests live under the `test/` folder in the repository. We use
72
+
`pytest` and the built-in test runner `python setup.py test`. If a test needs a
73
+
static file, like a .twb/.twbx, it should live under `test/assets/`
62
74
63
75
### Update the documentation
64
76
65
-
When adding a new feature or improving existing functionality we may ask that you update the documentation along with your code.
77
+
When adding a new feature or improving existing functionality we may ask that
78
+
you update the documentation along with your code.
66
79
67
-
Our documentation is written in markdown and built with Jekyll on GitHub Pages. All of the documentation source files can be found in `/docs` folder in the **gh-pages** branch. The docs are hosted on the following URL: [https://tableau.github.io/server-client-python](https://tableau.github.io/server-client-python)
80
+
Our documentation is written in markdown and built with Jekyll on GitHub Pages.
81
+
All of the documentation source files can be found in `/docs` folder in the
82
+
**gh-pages** branch. The docs are hosted on the following URL:
If you are just making documentation updates (adding new docs, fixing typos, improving wording) the easiest method is to use the built-in `Edit this file` feature right in GitHub (click the pencil icon). If you are viewing one of the pages on [https://tableau.github.io/server-client-python](https://tableau.github.io/server-client-python), clicking the **Edit this page** link at the top of the page will take you to the same place.
85
+
If you are just making documentation updates (adding new docs, fixing typos,
86
+
improving wording) the easiest method is to use the built-in `Edit this file`
87
+
feature right in GitHub (click the pencil icon). If you are viewing one of the
clicking the **Edit this page** link at the top of the page will take you to the
91
+
same place.
70
92
71
93
### Commit changes to your fork and open a PR
72
94
73
-
1. Make a PR as described [here](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) against the **development** branch for code changes, or against **gh-pages** for documentation updates.
against the **development** branch for code changes, or against **gh-pages**
98
+
for documentation updates.
74
99
75
-
1. Wait for a review and address any feedback.
76
-
While we try and stay on top of all issues and PRs it might take a few days for someone to respond. Politely pinging
77
-
the PR after a few days with no response is OK, we'll try and respond with a timeline as soon as we are able.
100
+
1. Wait for a review and address any feedback. While we try and stay on top of
101
+
all issues and PRs it might take a few days for someone to respond. Politely
102
+
pinging the PR after a few days with no response is OK, we'll try and respond
103
+
with a timeline as soon as we are able.
78
104
79
-
1. That's it! When the PR has received {:height="5%" width="5%"} (:rocket:'s) from members of the core team they will merge the PR.
0 commit comments