8000 Create feature_request.md (#1005) · ludwigrubio/server-client-python@4a1656e · GitHub
[go: up one dir, main page]

Skip to content

Commit 4a1656e

Browse files
authored
Create feature_request.md (tableau#1005)
* Create feature_request.md Add a template to differentiate bug reports and feature requests from users.
1 parent ea5945c commit 4a1656e

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: Feature Request
3+
title: "[REQUEST TYPE] [FEATURE TITLE]"
4+
about: Suggest a feature that could be added to the client
5+
labels: enhancement, needs investigation
6+
---
7+
8+
## Summary
9+
A one line description of the request. Skip this if the title is already a good summary.
10+
11+
12+
## Request Type
13+
If you know, say which of these types your request is in the title, and follow the suggestions for that type when writing your description.
14+
15+
****Type 1: support a REST API:****
16+
If it is functionality that already exists in the [REST API](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm), example API calls are the clearest way to explain your request.
17+
18+
****Type 2: add a REST API and support it in tsc.****
19+
If it is functionality that can be achieved somehow on Tableau Server but not through the REST API, describe the current way to do it. (e.g: functionality that is available in the Web UI, or by using the Hyper API). For UI, screenshots can be helpful.
20+
21+
****Type 3: new functionality****
22+
Requests for totally new functionality will generally be passed to the relevant dev team, but we probably can't give any useful estimate of how or when it might be implemented. If it is a feature that is 'about' the API or programmable access, here might be the best place to suggest it, but generally feature requests will be more visible in the [Tableau Community Ideas](https://community.tableau.com/s/ideas) forum and should go there instead.
23+
24+
25+
## Description
26+
A clear and concise description of what the feature request is. If you think that the value of this feature might not be obvious, include information like how often it is needed, amount of work saved, etc. If your feature request is related to a file or server in a specific state, describe the starting state when the feature can be used, and the end state after using it. If it involves modifying files, an example file may be helpful.
27+
![](https://img.shields.io/badge/warning-Be%20careful%20not%20to%20post%20user%20names%2C%20passwords%2C%20auth%20tokens%20or%20any%20other%20private%20or%20sensitive%20information-red)
28+

0 commit comments

Comments
 (0)
0