Skip to content

Commit 3a27d2b

Browse files
committed
Update contributing file to point to the newer Developer Guide instead
1 parent 91cdd5f commit 3a27d2b

File tree

1 file changed

+2
-63
lines changed

1 file changed

+2
-63
lines changed

Diff for: contributing.md

+2-63
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@ Contribution can include, but are not limited to, any of the following:
1010
* Fix an Issue/Bug
1111
* Add/Fix documentation
1212

13-
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.
14-
1513
## Issues and Feature Requests
1614

1715
To submit an issue/bug report, or to request a feature, please submit a [GitHub issue](https://github.com/tableau/server-client-python/issues) to the repo.
@@ -22,65 +20,6 @@ files to assist in the repro. **Be sure to scrub the files of any potentially s
2220
For a feature request, please try to describe the scenario you are trying to accomplish that requires the feature. This will help us understand
2321
the limitations that you are running into, and provide us with a use case to know if we've satisfied your request.
2422

25-
### Label usage on Issues
26-
27-
The core team is responsible for assigning most labels to the issue. Labels
28-
are used for prioritizing the core team's work, and use the following
29-
definitions for labels.
30-
31-
The following labels are only to be set or changed by the core team:
32-
33-
* **bug** - A bug is an unintended behavior for existing functionality. It only relates to existing functionality and the behavior that is expected with that functionality. We do not use **bug** to indicate priority.
34-
* **enhancement** - An enhancement is a new piece of functionality and is related to the fact that new code will need to be written in order to close this issue. We do not use **enhancement** to indicate priority.
35-
* **CLARequired** - This label is used to indicate that the contribution will require that the CLA is signed before we can accept a PR. This label should not be used on Issues
36-
* **CLANotRequired** - This label is used to indicate that the contribution does not require a CLA to be signed. This is used for minor fixes and usually around doc fixes or correcting strings.
37-
* **help wanted** - This label on an issue indicates it's a good choice for external contributors to take on. It usually means it's an issue that can be tackled by first time contributors.
38-
39-
The following labels can be used by the issue creator or anyone in the
40-
community to help us prioritize enhancement and bug fixes that are
41-
causing pain from our users. The short of it is, purple tags are ones that
42-
anyone can add to an issue:
43-
44-
* **Critical** - This means that you won't be able to use the library until the issues have been resolved. If an issue is already labeled as critical, but you want to show your support for it, add a +1 comment to the issue. This helps us know what issues are really impacting our users.
45-
* **Nice To Have** - This means that the issue doesn't block your usage of the library, but would make your life easier. Like with critical, if the issue is already tagged with this, but you want to show your support, add a +1 comment to the issue.
46-
47-
## Fixes, Implementations, and Documentation
48-
49-
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
50-
creating a PR can be found in the [Development Guide](https://tableau.github.io/server-client-python/docs/dev-guide).
51-
52-
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
53-
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
54-
somewhere.
55-
56-
## Getting Started
57-
58-
```shell
59-
python -m build
60-
pytest
61-
```
62-
63-
### To use your locally built version
64-
```shell
65-
pip install .
66-
```
67-
68-
### Debugging Tools
69-
See what your outgoing requests look like: https://requestbin.net/ (unaffiliated link not under our control)
70-
71-
72-
### Before Committing
73-
74-
Our CI runs include a Python lint run, so you should run this locally and fix complaints before committing as this will fail your checkin.
75-
76-
```shell
77-
# this will run the formatter without making changes
78-
black . --check
79-
80-
# this will format the directory and code for you
81-
black .
23+
### Making Contributions
8224

83-
# this will run type checking
84-
pip install mypy
85-
mypy tableauserverclient test samples
86-
```
25+
Refer to the [Developer Guide](https://tableau.github.io/server-client-python/docs/dev-guide) which explains how to make contributions to the TSC project.

0 commit comments

Comments
 (0)