forked from tableau/TabPy
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added contributing guide, updated README
- Loading branch information
Showing
2 changed files
with
28 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# Contributing Guide | ||
|
||
## Environment Setup | ||
|
||
TabPy suggests using [Pipenv](https://docs.pipenv.org) to configure and manage your development environment out of the box and provides facilities to enable this out of the box. To start, clone the source code and from the project root run: | ||
|
||
```sh | ||
pipenv install -dev | ||
``` | ||
|
||
This will create a dedicated virtual environment containing all of the development requirements, which you can subsequently activate to get started: | ||
|
||
```sh | ||
pipenv shell | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters