Update CONTRIBUTING.md

This commit is contained in:
Nick Sweeting 2021-01-13 05:55:46 -05:00 committed by GitHub
parent f50e49fa92
commit ab6fdb83be
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -9,15 +9,15 @@
**Useful links:** **Useful links:**
- https://github.com/pirate/ArchiveBox/issues - https://github.com/ArchiveBox/ArchiveBox/issues
- https://github.com/pirate/ArchiveBox/pulls - https://github.com/ArchiveBox/ArchiveBox/pulls
- https://github.com/pirate/ArchiveBox/wiki/Roadmap - https://github.com/ArchiveBox/ArchiveBox/wiki/Roadmap
- https://github.com/pirate/ArchiveBox/wiki/Install#manual-setup - https://github.com/ArchiveBox/ArchiveBox/wiki/Install#manual-setup
### Development Setup ### Development Setup
```bash ```bash
git clone https://github.com/pirate/ArchiveBox git clone https://github.com/ArchiveBox/ArchiveBox
cd ArchiveBox cd ArchiveBox
# Ideally do this in a virtualenv # Ideally do this in a virtualenv
pip install -e '.[dev]' # or use: pipenv install --dev pip install -e '.[dev]' # or use: pipenv install --dev
@ -31,6 +31,8 @@ pip install -e '.[dev]' # or use: pipenv install --dev
./bin/build.sh ./bin/build.sh
``` ```
For more common tasks see the `Development` section at the bottom of the README.
### Getting Help ### Getting Help
Open issues on Github or message me https://sweeting.me/#contact. Open issues on Github or message me https://sweeting.me/#contact.