Update CONTRIBUTING.md
This commit is contained in:
parent
5ecbb0e442
commit
622df14b47
1 changed files with 6 additions and 10 deletions
16
.github/CONTRIBUTING.md
vendored
16
.github/CONTRIBUTING.md
vendored
|
@ -19,22 +19,18 @@
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/pirate/ArchiveBox
|
git clone https://github.com/pirate/ArchiveBox
|
||||||
cd ArchiveBox
|
cd ArchiveBox
|
||||||
# Optionally create a virtualenv
|
# Ideally do this in a virtualenv
|
||||||
pip install -r requirements.txt
|
pip install -e '.[dev]' # or use: pipenv install --dev
|
||||||
pip install -e .
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Running Tests
|
### Running Tests
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
./bin/archive tests/*
|
./bin/lint.sh
|
||||||
# look for errors in stdout/stderr
|
./bin/test.sh
|
||||||
# then confirm output html looks right
|
./bin/build.sh
|
||||||
|
|
||||||
# if on >v0.4 run the django test suite:
|
|
||||||
archivebox manage test
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Getting Help
|
### Getting Help
|
||||||
|
|
||||||
Open issues on Github or contact me https://sweeting.me/#contact.
|
Open issues on Github or message me https://sweeting.me/#contact.
|
||||||
|
|
Loading…
Reference in a new issue