-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
26 additions
and
20 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
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 |
---|---|---|
@@ -1,2 +1,2 @@ | ||
include README.md LICENSE demo.gif | ||
include README.md LICENSE | ||
prune tests |
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 |
---|---|---|
@@ -1,24 +1,23 @@ | ||
# Contributing | ||
|
||
Set up development environment: | ||
Set up dev environment: | ||
```shell | ||
cd ~/your/colorpedia/clone # Activate venv if you have one (recommended) | ||
pip install -e .[dev] # Install dev dependencies (e.g. black, mypy, pre-commit) | ||
pre-commit install # Install git pre-commit hooks | ||
cd ~/your/repository/fork # Activate venv if you have one (recommended) | ||
pip install -e .[dev] # Install dev dependencies (e.g. black, mypy, pre-commit) | ||
pre-commit install # Install git pre-commit hooks | ||
``` | ||
|
||
Run unit tests with coverage: | ||
|
||
```shell | ||
py.test --cov=colorpedia --cov-report=html | ||
py.test --cov=./ --cov-report=html # Open htmlcov/index.html in your browser | ||
``` | ||
|
||
Build and test documentation (Colorpedia uses [MkDocs](https://www.mkdocs.org/)): | ||
Build and test documentation (Colorpedia uses [MkDocs](https://www.mkdocs.org)): | ||
```shell | ||
mkdocs serve # Go to http://127.0.0.1:8000 on your browser after | ||
mkdocs serve # Open http://127.0.0.1:8000 in your browser | ||
``` | ||
|
||
Add new colors [here](https://github.com/joowani/colorpedia/blob/main/colorpedia/hexcodes.py) | ||
You can add new colors [here](https://github.com/joowani/colorpedia/blob/main/colorpedia/hexcodes.py) | ||
and palettes [here](https://github.com/joowani/colorpedia/blob/main/colorpedia/palettes.py). | ||
|
||
Thank you for your contribution! |
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
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