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
|
||||
git clone https://github.com/pirate/ArchiveBox
|
||||
cd ArchiveBox
|
||||
# Optionally create a virtualenv
|
||||
pip install -r requirements.txt
|
||||
pip install -e .
|
||||
# Ideally do this in a virtualenv
|
||||
pip install -e '.[dev]' # or use: pipenv install --dev
|
||||
```
|
||||
|
||||
### Running Tests
|
||||
|
||||
```bash
|
||||
./bin/archive tests/*
|
||||
# look for errors in stdout/stderr
|
||||
# then confirm output html looks right
|
||||
|
||||
# if on >v0.4 run the django test suite:
|
||||
archivebox manage test
|
||||
./bin/lint.sh
|
||||
./bin/test.sh
|
||||
./bin/build.sh
|
||||
```
|
||||
|
||||
### 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