Mirrors/ArchiveBox
2
0
Fork 0
mirror of https://github.com/ArchiveBox/ArchiveBox synced 2024-11-14 00:17:08 +00:00
Code Issues Projects Releases Packages Wiki Activity
ArchiveBox/.github/CONTRIBUTING.md
Nick Sweeting ab6fdb83be
Update CONTRIBUTING.md
2021-01-13 05:55:46 -05:00

1.3 KiB
Raw Blame History

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:

Development Setup

git clone https://github.com/ArchiveBox/ArchiveBox
cd ArchiveBox
# Ideally do this in a virtualenv
pip install -e '.[dev]'  # or use: pipenv install --dev

Running Tests

./bin/lint.sh
./bin/test.sh
./bin/build.sh

For more common tasks see the Development section at the bottom of the README.

Getting Help

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