Skip to content

Commit fafba5d

Browse files
committed
Prettier reformat only
1 parent 2bcfefd commit fafba5d

File tree

1 file changed

+70
-36
lines changed

1 file changed

+70
-36
lines changed

docs/dev-guide.md

Lines changed: 70 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -3,24 +3,30 @@ title: Developer Guide
33
layout: docs
44
---
55

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.
78

8-
* TOC
9+
<!-- prettier-ignore -->
10+
- TOC
911
{:toc}
1012

1113
---
1214

1315
## Submit your first patch
1416

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.
1620

1721
### Get the source code and set up your branch
1822

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)
2025

2126
1. Fork the repository.
2227

23-
We follow the "Fork and Pull" model as described [here](https://help.github.com/articles/about-collaborative-development-models/).
28+
We follow the "Fork and Pull" model as described
29+
[here](https://help.github.com/articles/about-collaborative-development-models/).
2430

2531
1. Clone your fork:
2632

@@ -36,7 +42,8 @@ This section will get you started with the basic workflow, describing how to cre
3642

3743
1. Set up the feature, fix, or documentation branch.
3844

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:
4047

4148
```shell
4249
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
4653

4754
### Code and commit
4855

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):
5058

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.
5668

5769
### Add tests
5870

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/`
6274

6375
### Update the documentation
6476

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.
6679

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:
83+
[https://tableau.github.io/server-client-python](https://tableau.github.io/server-client-python)
6884

69-
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
88+
pages on
89+
[https://tableau.github.io/server-client-python](https://tableau.github.io/server-client-python),
90+
clicking the **Edit this page** link at the top of the page will take you to the
91+
same place.
7092

7193
### Commit changes to your fork and open a PR
7294

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.
95+
1. Make a PR as described
96+
[here](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork)
97+
against the **development** branch for code changes, or against **gh-pages**
98+
for documentation updates.
7499

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.
78104

79-
1. That's it! When the PR has received ![](https://github.githubassets.com/images/icons/emoji/unicode/1f680.png){:height="5%" width="5%"} (:rocket:'s) from members of the core team they will merge the PR.
105+
1. That's it! When the PR has received
106+
![](https://github.githubassets.com/images/icons/emoji/unicode/1f680.png){:height="5%"
107+
width="5%"} (:rocket:'s) from members of the core team they will merge the
108+
PR.
80109

81110
---
82111

83112
## Add new features
84113

85-
1. Create an endpoint class for the new feature, following the structure of the other endpoints. Each endpoint usually
86-
has `get`, `post`, `update`, and `delete` operations that require making the url, creating the XML request if necessary,
87-
sending the request, and creating the target item object based on the server response.
88-
89-
1. Create an item class for the new feature, following the structure of the other item classes. Each item has properties
90-
that correspond to what attributes are sent to/received from the server (refer to docs and Postman for attributes).
91-
Some items also require constants for user input that are limited to specific strings. After making all the
92-
properties, make the parsing method that takes the server response and creates an instances of the target item. If
93-
the corresponding endpoint class has an update function, then parsing is broken into multiple parts (refer to another
94-
item like workbook or datasource for example).
95-
96-
1. Add testing by getting real xml responses from the server, and asserting that all properties are parsed and set
97-
correctly.
114+
1. Create an endpoint class for the new feature, following the structure of the
115+
other endpoints. Each endpoint usually has `get`, `post`, `update`, and
116+
`delete` operations that require making the url, creating the XML request if
117+
necessary, sending the request, and creating the target item object based on
118+
the server response.
119+
120+
1. Create an item class for the new feature, following the structure of the
121+
other item classes. Each item has properties that correspond to what
122+
attributes are sent to/received from the server (refer to docs and Postman
123+
for attributes). Some items also require constants for user input that are
124+
limited to specific strings. After making all the properties, make the
125+
parsing method that takes the server response and creates an instances of the
126+
target item. If the corresponding endpoint class has an update function, then
127+
parsing is broken into multiple parts (refer to another item like workbook or
128+
datasource for example).
129+
130+
1. Add testing by getting real xml responses from the server, and asserting that
131+
all properties are parsed and set correctly.
98132

99133
1. Add a sample to show users how to use the new feature.
100134

0 commit comments

Comments
 (0)