Skip to content

Latest commit

 

History

History
58 lines (36 loc) · 737 Bytes

CONTRIBUTING.md

File metadata and controls

58 lines (36 loc) · 737 Bytes

Contributing

Please do contribute! Issues and pull requests are welcome.

Development

Source

Clone euchre-cli repo.

git clone https://github.com/boldandbrad/euchre-cli

Install local package in development mode.

Note: The pip line does not work in zsh for some reason. Run it in another shell.

cd euchre-cli
pip install -e .[dev]

Run the cli.

euchre --help

Docs

euchre-cli uses docsify for documentation.

Install the docsify cli.

npm install docsify-cli -g

Serve the docs on localhost:3000.

docsify serve docs

Tests

pytest

Branching Model

coming soon.

Versioning and Tagging

coming soon.