archivebox/.github/CONTRIBUTING.md

Contribution Process

1. Confirm your desired features fit into our bigger project goals Roadmap.
2. Open an issue with your planned implementation to discuss
3. Check in with me before starting development to make sure your work wont conflict with or duplicate existing work
4. Setup your dev environment, make some changes, and test using the test input files
5. Commit, push, and submit a PR and wait for review feedback
6. Have patience, don't abandon your PR! We love contributors but we all have day jobs and don't always have time to respond to notifications instantly. If you want a faster response, ping @theSquashSH on twitter or Patreon.

Useful links:

• https://github.com/ArchiveBox/ArchiveBox/issues
• https://github.com/ArchiveBox/ArchiveBox/pulls
• https://github.com/ArchiveBox/ArchiveBox/wiki/Roadmap
• https://github.com/ArchiveBox/ArchiveBox/wiki/Install#manual-setup

Development Setup

git clone https://github.com/ArchiveBox/ArchiveBox
cd ArchiveBox
python -m venv .venv
. .venv/bin/activate
pip install --upgrade bottle build flake8 pip pytest setuptools wheel
pip install -r requirements.txt
pip install -e .[sonic,ldap]

Testing & linting

pytest -s --basetemp=tests/out --ignore=archivebox/vendor
flake8 archivebox/ --config archivebox/.flake8 --count --show-source --statistics

Getting Help

Open issues on Github or message me https://sweeting.me/#contact.