-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add contributing guide and improve docs (#28)
* Rename docs/models.md --> docs/index.md * Add install instructions to the docs * Add contributing guide Closes #9 * Add note about adding models * Address comments
- Loading branch information
1 parent
d05ccb3
commit 6ca63c9
Showing
2 changed files
with
46 additions
and
0 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,36 @@ | ||
# Contributing to Larq | ||
|
||
👍 🎉 First off, thanks for taking the time to contribute! 👍 🎉 | ||
|
||
**Working on your first Pull Request?** You can learn how from this _free_ series | ||
[How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github). | ||
|
||
## Project setup | ||
|
||
To send a Pull Request it is required to fork Larq Zoo on GitHub. | ||
After that clone it to a desired directory: | ||
|
||
```shell | ||
git clone https://github.com/my-username/larq-zoo.git | ||
``` | ||
|
||
Install all required dependencies for local development by running: | ||
|
||
```shell | ||
cd larq-zoo # go into the directory you just cloned | ||
pip install -e .[tensorflow] # Installs Tensorflow for CPU | ||
# pip install -e .[tensorflow_gpu] # Installs Tensorflow for GPU | ||
pip install -e .[test] # Installs all development dependencies | ||
``` | ||
|
||
## Run Unit tests | ||
|
||
Inside the project directory run: | ||
|
||
```shell | ||
pytest . | ||
``` | ||
|
||
## Code style | ||
|
||
We use [`black`](https://black.readthedocs.io/en/stable/) to format all of our code. We recommend installing it as a plugin for your favorite [code editor](https://black.readthedocs.io/en/stable/editor_integration.html). |
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