Skip to content

Commit b6db361

Browse files
authored
Merge pull request #133 from grbritz/docs
Update to contributing docs
2 parents c1c4dd4 + 600e038 commit b6db361

File tree

3 files changed

+12
-3
lines changed

3 files changed

+12
-3
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ For more information, see the documentation:
77

88
<http://tableau.github.io/document-api-python>
99

10+
For more information, see the documentation:
11+
12+
<http://tableau.github.io/document-api-python>
13+
1014
Document API
1115
---------------
1216
The Document API provides a supported way to programmatically make updates to Tableau workbook and data source files. If you've been making changes to these file types by directly updating the XML--that is, by XML hacking--this SDK is for you :)

docs/docs/contributing.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,7 @@ anyone can add to an issue:
5151

5252
## Fixes, Implementations, and Documentation
5353

54-
For all other things, please submit a PR that includes the fix, documentation, or new code that you are trying to contribute. More information on
55-
creating a PR can be found in the [github documentation](https://help.github.com/articles/creating-a-pull-request/)
54+
For all other things, please submit a PR that includes the fix, documentation, or new code that you are trying to contribute. More information on submitting a PR can be found in the [developer guide](dev-guide.md)
5655

5756
If the feature is complex or has multiple solutions that could be equally appropriate approaches, it would be helpful to file an issue to discuss the
5857
design trade-offs of each solution before implementing, to allow us to collectively arrive at the best solution, which most likely exists in the middle

docs/docs/dev-guide.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,19 @@ layout: docs
1717
git clone https://github.com/<your_username>/document-api-python
1818
```
1919

20+
1. Check out the development branch
21+
22+
```shell
23+
git checkout development
24+
```
25+
2026
1. Run the tests to make sure everything is peachy:
2127

2228
```shell
2329
python setup.py test
2430
```
2531

26-
1. Set up the feature, fix, or documentation branch.
32+
1. Set up the feature, fix, or documentation branch.
2733

2834
It is recommended to use the format issue#-type-description (e.g. 13-fix-connection-bug) like so:
2935

0 commit comments

Comments
 (0)