diff --git a/CHANGELOG.md b/CHANGELOG.md index b53abc0..49783e1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +## 05 (01 November 2016) + +* Added ability to set the port for connections (#97) +* Added ability to read and write caption for datasources (#99) +* Added documentation + ## 0.4 (07 October 2016) * Add ability to remove repository location (#86) diff --git a/contributing.md b/contributing.md deleted file mode 100644 index 15fc5f8..0000000 --- a/contributing.md +++ /dev/null @@ -1,33 +0,0 @@ -# Contributing - -We welcome contributions to this project! - -Contribution can include, but are not limited to, any of the following: - -* File an Issue -* Request a Feature -* Implement a Requested Feature -* Fix an Issue/Bug -* Add/Fix documentation - -Contributions must follow the guidelines outlined on the [Tableau Organization](http://tableau.github.io/) page, though filing an issue or requesting -a feature do not require the CLA. - -## Issues and Feature Requests - -To submit an issue/bug report, or to request a feature, please submit a [github issue](https://github.com/tableau/document-api-python/issues) to the repo. - -If you are submiting a bug report, please provide as much information as you can, including clear and concise repro steps, attaching any necessary -files to assist in the repro. **Be sure to scrub the files of any potentially sensitive information. Issues are public.** - -For a feature request, please try to describe the scenario you are trying to accomplish that requires the feature. This will help us understand -the limitations that you are running into, and provide us with a use case to know if we've satisfied your request. - -## Fixes, Implementations, and Documentation - -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 -creating a PR can be found in the [github documentation](https://help.github.com/articles/creating-a-pull-request/) - -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 -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 -somewhere. diff --git a/contributing.md b/contributing.md new file mode 120000 index 0000000..e047e03 --- /dev/null +++ b/contributing.md @@ -0,0 +1 @@ +docs/docs/contributing.md \ No newline at end of file diff --git a/docs/_config.yml b/docs/_config.yml index 1a4c913..5fefbee 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,6 +1,6 @@ # Site settings title: Tableau Document API -email: jdominguez@tableau.com +email: github@tableau.com description: Programmatically update your Tableau workbooks and data sources. baseurl: "/document-api-python" permalinks: pretty diff --git a/docs/_layouts/docs.html b/docs/_layouts/docs.html index 1269e39..d229de4 100644 --- a/docs/_layouts/docs.html +++ b/docs/_layouts/docs.html @@ -17,7 +17,7 @@

{{ page.title }}

- Edit this page + Edit this page   Submit an issue
diff --git a/docs/docs/contributing.md b/docs/docs/contributing.md index 1ea1553..1d45c67 100644 --- a/docs/docs/contributing.md +++ b/docs/docs/contributing.md @@ -2,6 +2,7 @@ title: Contributing layout: docs --- +# Contributing We welcome contributions to this project! diff --git a/docs/docs/dev-guide.md b/docs/docs/dev-guide.md index cd6bfee..a77013f 100644 --- a/docs/docs/dev-guide.md +++ b/docs/docs/dev-guide.md @@ -3,17 +3,22 @@ title: Developer Guide layout: docs --- -### Making your first patch +<<<<<<< 6ee666bf06d5ab59931100b3955779c35693e33f +## Submitting your first patch -1. Make sure you've signed the CLA +1. Make sure you have [signed the CLA](http://tableau.github.io/#contributor-license-agreement-cla) -1. Clone the repo +1. Fork the repository. + + We follow the "Fork and Pull" model as described [here](https://help.github.com/articles/about-collaborative-development-models/). + +1. Clone your fork: ```shell - git clone http://github.com/tableau/document-api-python + git clone http://github.com//document-api-python ``` -1. Run the tests to make sure everything is peachy +1. Run the tests to make sure everything is peachy: ```shell python setup.py test @@ -21,33 +26,44 @@ layout: docs 1. Set up the feature, fix, or documentation branch. - It is recommended to use the format [issue#]-[type]-[description] (e.g. 13-fix-connection-bug) + It is recommended to use the format issue#-type-description (e.g. 13-fix-connection-bug) like so: ```shell git checkout -b 13-feature-new-stuff ``` -1. Code and Commit! +1. Code and commit! + + Here's a quick checklist for ensuring a good pull request: + + - Only touch the minimal amount of files possible while still accomplishing the goal. + - Ensure all indentation is done as 4-spaces and your editor is set to unix line endings. + - The code matches PEP8 style guides. If you cloned the repo you can run `pycodestyle .` + - Keep commit messages clean and descriptive. + 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. - Here's a quick checklist for ensuring a good diff: +1. Add tests. - - The diff touches the minimal amount of files possible while still fufilling the purpose of the diff - - The diff uses Unix line endings - - The diff adheres to our PEP8 style guides. If you've cloned the repo you can run `pycodestyle .` + All of our tests live under the `test/` folder in the repository. + We use `unittest` and the built-in test runner `python setup.py test`. + If a test needs a static file, like a twb/twbx, it should live under `test/assets/` -1. Add Tests +1. Update the documentation. -1. Update Documentation + Our documentation is written in markdown and built with Jekyll on Github Pages. All of the documentation source files can be found in `docs/docs`. - Our documentation is written in markdown and built with [Mkdocs](http://www.mkdocs.org). More information on how to update and build the docs can be found [here](#updating-documentation) + When adding a new feature or improving existing functionality we may ask that you update the documentation along with your code. + + If you are just making a PR for documentation updates (adding new docs, fixing typos, improving wording) the easiest method is to use the built in `Edit this file` in the Github UI -1. Run the tests again and make sure they pass! +1. Submit to your fork. -1. Submit to your fork +1. Make a PR as described [here](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) against the 'development' branch. -1. Submit a PR +1. Wait for a review and address any feedback. + While we try and stay on top of all issues and PRs it might take a few days for someone to respond. Politely pinging 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. -1. Wait for a review, and address any feedback. +1. That's it! When the PR has received :rocket:'s from members of the core team they will merge the PR