|
| 1 | +# Contributing |
| 2 | + |
1 | 3 | The bottom line. Follow your Nose, or our Nose. Write-run-love tests :fist:.
|
2 | 4 |
|
| 5 | +## Code of Conduct |
| 6 | + |
| 7 | +Check out the [Code of Conduct](CODE_OF_CONDUCT.md). Don't tl:dr; it, but the general idea is to be nice. |
| 8 | + |
| 9 | +## Got Questions? |
| 10 | + |
| 11 | +Open an issue! Go to https://github.com/plotly/plotly.py/issues. It's possible that your issue was already addressed. If it wasn't, open it. We also accept PRs; take a look at the steps below for instructions on how to do this. |
| 12 | + |
3 | 13 | ## Setup
|
4 | 14 |
|
5 | 15 | ### Fork, Clone, Setup Your Version of the Plotly Python API
|
@@ -53,7 +63,7 @@ Once you've made your changes (and hopefully written some tests...), make that p
|
53 | 63 | ## Suggestions
|
54 | 64 |
|
55 | 65 | ### Local Python
|
56 |
| -Setting up Python versions that *don't* require you to use `sudo` is a good idea. In addition, the core Python on your machine may not be the Python that we've developed in! Here are some nice guides for Mac, Windows, and Linux: |
| 66 | +Setting up Python versions that *don't* require you to use `sudo` is a good idea. In addition, the core Python on your machine may not be the Python that we've developed in! Here are some nice guides for Mac, Windows, and Linux: |
57 | 67 | - http://docs.python-guide.org/en/latest/starting/install/osx/
|
58 | 68 | - http://docs.python-guide.org/en/latest/starting/install/win/
|
59 | 69 | - http://docs.python-guide.org/en/latest/starting/install/linux/
|
@@ -82,7 +92,7 @@ export PYTHONPATH="/path/to/local/repo:$PYTHONPATH"
|
82 | 92 |
|
83 | 93 | ## Dependencies
|
84 | 94 |
|
85 |
| -There's a short list of core dependencies you'll need installed in your Python environment to have any sort of fun with Plotly's Python API (see `requirements.txt`). Additionally, you're likely to have even more fun if you install some other requirements (see `optional-requirements.txt`). |
| 95 | +There's a short list of core dependencies you'll need installed in your Python environment to have any sort of fun with Plotly's Python API (see `requirements.txt`). Additionally, you're likely to have even more fun if you install some other requirements (see `optional-requirements.txt`). |
86 | 96 |
|
87 | 97 | ### Dependencies and Virtualenv
|
88 | 98 |
|
@@ -176,27 +186,26 @@ tox -- -a '!slow','!matplotlib'
|
176 | 186 |
|
177 | 187 | ### Writing Tests
|
178 | 188 |
|
179 |
| -You're *strongly* encouraged to write tests that check your added functionality. |
| 189 | +You're *strongly* encouraged to write tests that check your added functionality. |
180 | 190 |
|
181 | 191 | When you write a new test anywhere under the `tests` directory, if your PR gets accepted, that test will run in a virtual machine to ensure that future changes don't break your contributions!
|
182 | 192 |
|
183 | 193 | #### Publishing to Pip
|
184 | 194 |
|
185 | 195 | You'll need the credentials file `~/.pypirc`. Request access from @theengineear and @chriddyp. Then, from inside the repository:
|
186 | 196 |
|
187 |
| -``` |
| 197 | +```bash |
188 | 198 | (plotly.py) $ git checkout master
|
189 | 199 | (plotly.py) $ git stash
|
190 | 200 | (plotly.py) $ git pull origin master
|
191 | 201 | (plotly.py) $ python setup.py sdist upload # upload to pip
|
192 | 202 | ```
|
193 | 203 |
|
194 | 204 | After it has uploaded, move to another directly and double+triple check that you are able to upgrade ok:
|
195 |
| -``` |
| 205 | +```bash |
196 | 206 | $ pip install plotly --upgrade
|
197 | 207 | ```
|
198 | 208 |
|
199 | 209 | And ask one of your friends to do it too. Our tests should catch any issues, but you never know.
|
200 | 210 |
|
201 |
| - |
202 | 211 | <3 Team Plotly
|
0 commit comments