Introduce contribution and code of conduct docs

CONTRIBUTING.md

@@ -1,34 +1,7 @@
-# Development
+# Contributing
 
-To start development you should begin by cloning the repo.
+Thanks for the interest! See the [contributor documentation][contribute]
+to get started, and reach out on [Gitter][gitter] if you get stuck.
 
-```bash
-$ git clone [email protected]/ethereum/web3.py.git
-```
-
-
-# Cute Animal Pictures
-
-All pull requests need to have a cute animal picture.  This is a very important
-part of the development process.
-
-
-# Pull Requests
-
-In general, pull requests are welcome.  Please try to adhere to the following.
-
-- code should conform to PEP8 and as well as the linting done by `flake8 web3/ tests/`
-- include tests.
-- include any relevant documentation updates.
-
-It's a good idea to make pull requests early on.  A pull request represents the
-start of a discussion, and doesn't necessarily need to be the final, finished
-submission.
-
-GitHub's documentation for working on pull requests is [available here](https://help.github.com/articles/about-pull-requests/).
-
-Always run the tests before submitting pull requests, and ideally run `tox` in
-order to check that your modifications don't break anything.
-
-Once you've made a pull request take a look at the travis build status in the
-GitHub interface and make sure the tests are runnning as you'd expect.
+[contribute]: https://web3py.readthedocs.io/en/latest/contributing.html
+[gitter]: https://gitter.im/ethereum/web3.py

README.md

@@ -1,196 +1,25 @@
 # Web3.py
 
+[![Documentation Status](https://readthedocs.org/projects/web3py/badge/?version=latest)](https://web3py.readthedocs.io/en/latest/?badge=latest)
 [![Join the chat at https://gitter.im/ethereum/web3.py](https://badges.gitter.im/ethereum/web3.py.svg)](https://gitter.im/ethereum/web3.py?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-
 [![Build Status](https://circleci.com/gh/ethereum/web3.py.svg?style=shield)](https://circleci.com/gh/ethereum/web3.py)
 
-
-A Python implementation of [web3.js](https://github.com/ethereum/web3.js)
+A Python library for interacting with Ethereum, inspired by [web3.js](https://github.com/ethereum/web3.js).
 
 * Python 3.6+ support
 
-Read more in the [documentation on ReadTheDocs](http://web3py.readthedocs.io/). [View the change log on Github](docs/releases.rst).
-
-## Developer Setup
-
-```sh
-git clone --recursive [email protected]:ethereum/web3.py.git
-cd web3.py
-```
-
-Please see OS-specific instructions for:
-
-- [Linux](docs/README-linux.md#Developer-Setup)
-- [Mac](docs/README-osx.md#Developer-Setup)
-- [Windows](docs/README-windows.md#Developer-Setup)
-- [FreeBSD](docs/README-freebsd.md#Developer-Setup)
-
-Then run these install commands:
-
-```sh
-virtualenv venv
-. venv/bin/activate
-pip install -e .[dev]
-```
-
-For different environments, you can set up multiple `virtualenv`. For example, if you want to create a `venvdocs`, then you do the following:
-
-```sh
-virtualenv venvdocs
-. venvdocs/bin/activate
-pip install -e .[docs]
-pip install -e .
-```
-
-## Using Docker
-
-If you would like to develop and test inside a Docker environment, use the *sandbox* container provided in the **docker-compose.yml** file.
-
-To start up the test environment, run:
-
-```
-docker-compose up -d
-```
-
-This will build a Docker container set up with an environment to run the Python test code.
-
-**Note: This container does not have `go-ethereum` installed, so you cannot run the go-ethereum test suite.**
-
-To run the Python tests from your local machine:
-
-```
-docker-compose exec sandbox bash -c 'pytest -n 4 -f -k "not goethereum"'
-```
-
-You can run arbitrary commands inside the Docker container by using the `bash -c` prefix.
-
-```
-docker-compose exec sandbox bash -c ''
-```
-
-Or, if you would like to just open a session to the container, run:
-
-```
-docker-compose exec sandbox bash
-```
-
-### Testing Setup
-
-During development, you might like to have tests run on every file save.
-
-Show flake8 errors on file change:
-
-```sh
-# Test flake8
-when-changed -v -s -r -1 web3/ tests/ ens/ -c "clear; flake8 web3 tests ens && echo 'flake8 success' || echo 'error'"
-```
-
-You can use `pytest-watch`, running one for every Python environment:
-
-```sh
-pip install pytest-watch
-
-cd venv
-ptw --onfail "notify-send -t 5000 'Test failure ⚠⚠⚠⚠⚠' 'python 3 test on web3.py failed'" ../tests ../web3
-```
-
-Or, you can run multi-process tests in one command, but without color:
-
-```sh
-# in the project root:
-pytest --numprocesses=4 --looponfail --maxfail=1
-# the same thing, succinctly:
-pytest -n 4 -f --maxfail=1
-```
-
-#### How to Execute the Tests?
-
-1. [Setup your development environment](https://github.com/ethereum/web3.py/#developer-setup).
-
-2. Execute `tox` for the tests
-
-There are multiple [components](https://github.com/ethereum/web3.py/blob/master/.circleci/config.yml#L144) of the tests. You can run test to against specific component. For example:
-
-```sh
-# Run Tests for the Core component (for Python 3.6):
-tox -e py36-core
-
-# Run Tests for the Core component (for Python 3.7):
-tox -e py37-core
-```
-
-If for some reason it is not working, add `--recreate` params.
-
-`tox` is good for testing against the full set of build targets. But if you want to run the tests individually, `pytest` is better for development workflow. For example, to run only the tests in one file:
-
-```sh
-pytest tests/core/gas-strategies/test_time_based_gas_price_strategy.py
-```
-
-### Release setup
-
-For Debian-like systems:
-```
-apt install pandoc
-```
-
-The final step before releasing is to build and test the code that will be released.
-There is a test script that will build and install the wheel locally,
-then generate a temporary virtualenv where you can do some smoke testing:
-
-```
-# Branch name could be either master or a version branch - ex. v5
-
-$ git checkout <branch name> && git pull
-
-$ make package
-
-# in another shell, navigate to the virtualenv mentioned in output of ^
-
-# load the virtualenv with the packaged trinity release
-$ source package-smoke-test/bin/activate
-
-# smoke test the release
-$ pip install ipython
-$ ipython
->>> from web3.auto import w3
->>> w3.isConnected()
->>> ...
-```
-
-To preview the upcoming documentation:
-
-```sh
-make docs
-```
-
-To preview the upcoming release notes:
-
-```sh
-towncrier --draft
-```
-
-To compile and commit the release notes:
-
-```sh
-make notes bump=$$VERSION_PART_TO_BUMP$$
-```
-
-When the release notes are ready, release a new version:
-
-```sh
-make release bump=$$VERSION_PART_TO_BUMP$$
-```
+## Quickstart
 
-#### How to bumpversion
+[Get started in 5 minutes](https://web3py.readthedocs.io/en/latest/quickstart.html) or
+[take a tour](https://web3py.readthedocs.io/en/latest/overview.html) of the library.
 
-The version format for this repo is `{major}.{minor}.{patch}` for stable, and
-`{major}.{minor}.{patch}-{stage}.{devnum}` for unstable (`stage` can be alpha or beta).
+## Documentation
 
-To issue the next version in line, specify which part to bump,
-like `make release bump=minor` or `make release bump=devnum`.
+For additional guides, examples, and APIs, see the [documentation](https://web3py.readthedocs.io/en/latest/).
 
-If you are in a beta version, `make release bump=stage` will switch to a stable.
+## Want to help?
 
-To issue an unstable version when the current version is stable, specify the
-new version explicitly, like `make release bump="--new-version 4.0.0-alpha.1 devnum"`
+Want to file a bug, contribute some code, or improve documentation? Excellent! Read up on our
+guidelines for [contributing](https://web3py.readthedocs.io/en/latest/contributing.html),
+then check out issues that are labeled
+[Good First Issue](https://github.com/ethereum/web3.py/issues?q=is%3Aissue+is%3Aopen+label%3A%22Good+First+Issue%22).

docs/code_of_conduct.rst

@@ -0,0 +1,78 @@
+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,
+education, socio-economic status, 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 [email protected]. 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 <https://www.contributor-covenant.org>`_, version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html