docs: add repository docs
This commit is contained in:
parent
cf7673c51c
commit
bcfab0fbad
3 changed files with 146 additions and 0 deletions
24
CONTRIBUTING.md
Normal file
24
CONTRIBUTING.md
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
# Contribution Guidelines
|
||||
|
||||
TODO
|
||||
|
||||
## Prerequisites
|
||||
|
||||
You need the following tools to be installed:
|
||||
|
||||
|
||||
* Python (> ver. 3.7)
|
||||
|
||||
|
||||
* Python *pip* module
|
||||
|
||||
```shell
|
||||
$ git clone git@bitbucket.org:victorykit/httpaste.git
|
||||
$ cd httpaste
|
||||
$ python3 -m pipenv install -d
|
||||
$ python3 -m pipenv run tox -e test
|
||||
$ python3 -m pipenv run tox -e build
|
||||
$ python3 -m pipenv run tox -e docs
|
||||
$ python3 -m pipenv run tox -e lint
|
||||
$ python3 -m pipenv run tox -e format
|
||||
```
|
||||
Loading…
Add table
Add a link
Reference in a new issue