diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000000..e399a9db3cc --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,74 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or +advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at accounts@plot.ly. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ diff --git a/LICENSE.txt b/LICENSE.txt index ae3a855cb18..7c4610a4f7c 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2016 Plotly, Inc +Copyright (c) 2016-2017 Plotly, Inc Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 6a8c5ba437d..7c81566b1ca 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ -## plotly.py -##### an interactive, browser-based charting library for python +# plotly.py + +> An interactive, browser-based graphing library for Python :sparkles: Plotly for Python is now entirely open source, free, and self-hosted. @@ -7,10 +8,20 @@ Plotly for Python is now entirely open source, free, and self-hosted. [![](https://plot.ly/~chriddyp/1780/.png)](https://plot.ly/~chriddyp/1780.embed) -### [Documentation](https://plot.ly/python) +## [Documentation](https://plot.ly/python) + +Take a look at [the website docs](https://plot.ly/python). + +Or, check out the [README.rst](README.rst) for more. -### Contributing +## Contribute Heck yeah! We've got suggestions! We've got guides! -Checkout [`contributing.md`](https://github.com/plotly/python-api/blob/master/contributing.md). +Check out [`contributing.md`](https://github.com/plotly/python-api/blob/master/contributing.md). + +Also, all interactions with Plotly are governed by the [Code of Conduct](CODE_OF_CONDUCT.md). Just saying. + +## License + +[MIT](LICENSE.txt) © 2016-2017 Plotly, Inc. diff --git a/README.rst b/README.rst index 3b5c5427723..e2481bc517a 100644 --- a/README.rst +++ b/README.rst @@ -74,7 +74,7 @@ plotly figures, with a one-liner:: py.plot_mpl(fig) -Checkout the `Plotly and mpld3`_ IPython notebook for more infomataion. +Checkout the `Plotly and mpld3`_ IPython notebook for more information. Introduction to working with out API ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/contributing.md b/contributing.md index fd07f349e9d..e86aeaabae5 100644 --- a/contributing.md +++ b/contributing.md @@ -1,5 +1,15 @@ +# Contributing + The bottom line. Follow your Nose, or our Nose. Write-run-love tests :fist:. +## Code of Conduct + +Check out the [Code of Conduct](CODE_OF_CONDUCT.md). Don't tl:dr; it, but the general idea is to be nice. + +## Got Questions? + +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. + ## Setup ### 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 ## Suggestions ### Local Python -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: +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: - http://docs.python-guide.org/en/latest/starting/install/osx/ - http://docs.python-guide.org/en/latest/starting/install/win/ - http://docs.python-guide.org/en/latest/starting/install/linux/ @@ -82,7 +92,7 @@ export PYTHONPATH="/path/to/local/repo:$PYTHONPATH" ## Dependencies -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`). +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`). ### Dependencies and Virtualenv @@ -176,7 +186,7 @@ tox -- -a '!slow','!matplotlib' ### Writing Tests -You're *strongly* encouraged to write tests that check your added functionality. +You're *strongly* encouraged to write tests that check your added functionality. 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! @@ -184,7 +194,7 @@ When you write a new test anywhere under the `tests` directory, if your PR gets You'll need the credentials file `~/.pypirc`. Request access from @theengineear and @chriddyp. Then, from inside the repository: -``` +```bash (plotly.py) $ git checkout master (plotly.py) $ git stash (plotly.py) $ git pull origin master @@ -192,11 +202,10 @@ You'll need the credentials file `~/.pypirc`. Request access from @theengineear ``` After it has uploaded, move to another directly and double+triple check that you are able to upgrade ok: -``` +```bash $ pip install plotly --upgrade ``` And ask one of your friends to do it too. Our tests should catch any issues, but you never know. - <3 Team Plotly