|
| 1 | +# Contributing |
| 2 | + |
| 3 | +We welcome contributions to this project! |
| 4 | + |
| 5 | +Contribution can include, but are not limited to, any of the following: |
| 6 | + |
| 7 | +* File an Issue |
| 8 | +* Request a Feature |
| 9 | +* Implement a Requested Feature |
| 10 | +* Fix an Issue/Bug |
| 11 | +* Add/Fix documentation |
| 12 | + |
| 13 | +Contributions must follow the guidelines outlined on the [Tableau Organization](http://tableau.github.io/) page, though filing an issue or requesting |
| 14 | +a feature do not require the CLA. |
| 15 | + |
| 16 | +## Issues and Feature Requests |
| 17 | + |
| 18 | +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. |
| 19 | + |
| 20 | +If you are submiting a bug report, please provide as much information as you can, including clear and concise repro steps, attaching any necessary |
| 21 | +files to assist in the repro. **Be sure to scrub the files of any potentially sensitive information. Issues are public.** |
| 22 | + |
| 23 | +For a feature request, please try to describe the scenario you are trying to accomplish that requires the feature. This will help us understand |
| 24 | +the limitations that you are running into, and provide us with a use case to know if we've satisfied your request. |
| 25 | + |
| 26 | +## Fixes, Implementations, and Documentation |
| 27 | + |
| 28 | +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 |
| 29 | +creating a PR can be found in the [github documentation](https://help.github.com/articles/creating-a-pull-request/) |
| 30 | + |
| 31 | +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 |
| 32 | +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 |
| 33 | +somewhere. |
0 commit comments