[CIVIS-1656] DOC update `CONTRIBUTING.md`

civisanalytics / civis-python

Civis API Python Client

BSD 3-Clause "New" or "Revised" License

34 stars 26 forks source link

[CIVIS-1656] DOC update `CONTRIBUTING.md` #433

Closed jacksonlee-civis closed 3 years ago

jacksonlee-civis commented 3 years ago

This PR updates CONTRIBUTING.md to clarify how to install civis-python locally and the differences between Civis vs non-Civis employees. Here's how GitHub renders the changes from this PR branch: https://github.com/civisanalytics/civis-python/blob/civis-1656-contributing-docs/CONTRIBUTING.md

jacksonlee-civis commented 3 years ago

The overall build status as shown on GitHub is not going to pass, because we've just turned on CircleCI for this repo, but the CircleCI configuration file isn't in yet (#432 is still open at the moment). As long as the TravisCI portion is all green, we should be good here.