Repository navigation
Add CONTRIBUTING.md and contributor quickstart - #9
Merged
Merged
Conversation
Covers dev setup (including the optional decaffeinator submodule), the pytest + doctor checks, branch and PR workflow, adding browser-free tests, Python 3.11 compatibility, and bug-report/security guidance. Closes #5
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #5
What
Adds
CONTRIBUTING.mdand links it from the README, covering:decaffeinatorsubmodule for VAPT, virtualenv,pip install -e ".[dev]", Patchright Chromium, and--doctor.pytest tests -qplus thewebvac --doctorsmoke check, matching what CI runs.main, focused commits, conventional prefixes,Closes #N, green CI, no force-push after review, squash merge.tests/.README changes: the existing short "Contributing Workflow" section now points to the full guide, and
CONTRIBUTING.mdis added to the documentation index.Verification
Docs-only change; no runtime behaviour touched. Links resolve to existing files (
LICENSE,docs/SECURITY.md). CI will confirm the tree still builds and tests pass on all four matrix cells.