From 959eb493c659b11de1db54a1794bdd016b8c5bd2 Mon Sep 17 00:00:00 2001 From: Russell Hay Date: Thu, 7 Jul 2016 10:40:11 -0700 Subject: [PATCH 1/4] Adding contributing.md first draft --- contributing.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 contributing.md diff --git a/contributing.md b/contributing.md new file mode 100644 index 0000000..9cc4dc1 --- /dev/null +++ b/contributing.md @@ -0,0 +1,14 @@ +# 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. From 7084ad1e15a535af3b2e166244fc1dee46a04119 Mon Sep 17 00:00:00 2001 From: Russell Hay Date: Thu, 7 Jul 2016 13:22:28 -0700 Subject: [PATCH 2/4] Adding information about Issues, Feature requests, and PRs Based on feedback from @lbrendanl --- contributing.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/contributing.md b/contributing.md index 9cc4dc1..959e1bc 100644 --- a/contributing.md +++ b/contributing.md @@ -12,3 +12,18 @@ Contribution can include, but are not limited to, any of the following: 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/) From 423be5040ba327dc80edd1667d8326026001c167 Mon Sep 17 00:00:00 2001 From: Russell Hay Date: Fri, 8 Jul 2016 09:51:45 -0700 Subject: [PATCH 3/4] Adding additional detail to the the feature PR section based on feedback from @benlower --- contributing.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/contributing.md b/contributing.md index 959e1bc..50b965a 100644 --- a/contributing.md +++ b/contributing.md @@ -27,3 +27,7 @@ the limitations that you are running into, and provide us with a use case to kno 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 collective arrive at the best solution, which most likely exists in the middle +somewhere. From 8f1937019bac91fcbd5fffdee3937ffe74a701be Mon Sep 17 00:00:00 2001 From: Russell Hay Date: Fri, 8 Jul 2016 13:02:22 -0700 Subject: [PATCH 4/4] fixing typo --- contributing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contributing.md b/contributing.md index 50b965a..15fc5f8 100644 --- a/contributing.md +++ b/contributing.md @@ -29,5 +29,5 @@ For all other things, please submit a PR that includes the fix, documentation, o 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 collective arrive at the best solution, which most likely exists in the middle +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. pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy