Skip to content

Commit 9156941

Browse files
jerrybelmonteakodali18Yuqi Jin
authored
Update docs to include CSP authentication support (#114)
Co-authored-by: Anil Kodali <akodali@vmware.com> Co-authored-by: Yuqi Jin <jyuqi@vmware.com> Co-authored-by: Jerry Belmonte<bjerry@vmware.com> Co-authored-by: John Cornish<jcornish@vmware.com>
1 parent 8e62d5a commit 9156941

6 files changed

Lines changed: 219 additions & 166 deletions

File tree

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,5 @@ lib64/
99
env/
1010
venv/
1111
.idea/
12-
.vscode/
12+
.vscode/
13+
.envrc

CONTRIBUTING.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# How to Contribute
2+
3+
* Reach out to us on our public [Slack channel](https://www.wavefront.com/join-public-slack).
4+
* If you run into any issues, let us know by creating a GitHub issue.
5+
6+
## Testing
7+
8+
We have a handful of GitHub actions to check code and run tests, but most of our testbeds consist of Python [unittest](https://docs.python.org/3/library/unittest.html). Please write Python [unittest](https://docs.python.org/3/library/unittest.html#basic-example) for new code that you create.
9+
10+
## Submitting Changes
11+
12+
* When submitting changes, make sure that you increment the **version** number in [setup.py](setup.py).
13+
The version number is documented as such in the setup.py file.
14+
* We follow [semantic versioning](https://semver.org/).
15+
* For bug fixes, increment the patch version (last number).
16+
* For backward compatible changes to the API, update the minor version (second number), and zero out the patch version.
17+
* For breaking changes to the API, increment the major version (first number) and zero out the minor and patch versions.
18+
19+
## Coding Conventions
20+
21+
Start reading our code and you'll get the hang of it. We use linters and the following and code checks:
22+
23+
* Install Linters
24+
25+
```bash
26+
python -m pip install -U flake8 flake8-colors
27+
python -m pip install -U flake8-import-order pep8-naming
28+
python -m pip install -U pydocstyle pylint
29+
```
30+
31+
* Install Extra Dependencies
32+
33+
```bash
34+
python -m pip install -U Deprecated requests tdigest
35+
```
36+
37+
* Run Flake8 Checks
38+
39+
```bash
40+
python -m flake8
41+
```
42+
43+
* Run PyLint Checks
44+
45+
```bash
46+
python -m pylint -d duplicate-code wavefront_sdk
47+
```
48+
49+
* Run PyDocStyle
50+
51+
```bash
52+
python -m pydocstyle
53+
```
54+
55+
* Execute Unit Tests
56+
57+
```bash
58+
python -m unittest discover
59+
```

0 commit comments

Comments
 (0)