8000 Adding title, CoC, and issues sections · loopbio/plotly.py@05853f5 · GitHub
[go: up one dir, main page]

Skip to content < 8000 script type="application/json" data-target="react-partial.embeddedData">{"props":{"docsUrl":"https://docs.github.com/get-started/accessibility/keyboard-shortcuts"}}

Commit 05853f5

Browse files
committed
Adding title, CoC, and issues sections
1 parent 9d3d664 commit 05853f5

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

contributing.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
1+
# Contributing
2+
13
The bottom line. Follow your Nose, or our Nose. Write-run-love tests :fist:.
24

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+
313
## Setup
414

515
### 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
5363
## Suggestions
5464

5565
### 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:
5767
- http://docs.python-guide.org/en/latest/starting/install/osx/
5868
- http://docs.python-guide.org/en/latest/starting/install/win/
5969
- http://docs.python-guide.org/en/latest/starting/install/linux/
@@ -82,7 +92,7 @@ export PYTHONPATH="/path/to/local/repo:$PYTHONPATH"
8292

8393
## Dependencies
8494

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`).
8696

8797
### Dependencies and Virtualenv
8898

@@ -176,27 +186,26 @@ tox -- -a '!slow','!matplotlib'
176186

177187
### Writing Tests
178188

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.
180190

181191
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!
182192

183193
#### Publishing to Pip
184194

185195
You'll need the credentials file `~/.pypirc`. Request access from @theengineear and @chriddyp. Then, from inside the repository:
186196

187-
```
197+
```bash
188198
(plotly.py) $ git checkout master
189199
(plotly.py) $ git stash
190200
(plotly.py) $ git pull origin master
191201
(plotly.py) $ python setup.py sdist upload # upload to pip
192202
```
193203

194204
After it has uploaded, move to another directly and double+triple check that you are able to upgrade ok:
195-
```
205+
```bash
196206
$ pip install plotly --upgrade
197207
```
198208

199209
And ask one of your friends to do it too. Our tests should catch any issues, but you never know.
200210

201-
202211
<3 Team Plotly

0 commit comments

Comments
 (0)
0