Skip to content

docs: populate CONTRIBUTING.md with full contribution guide - #2

Merged
0x5t4l1n merged 1 commit into
mainfrom
copilot/update-contributing-md
Apr 8, 2026
Merged

docs: populate CONTRIBUTING.md with full contribution guide#2
0x5t4l1n merged 1 commit into
mainfrom
copilot/update-contributing-md

Conversation

Copilot AI commented Apr 8, 2026

Copy link
Copy Markdown
Contributor

CONTRIBUTING.md was completely empty. This PR replaces it with a comprehensive guide tailored to the ExecuTrace project.

What's added

  • Code of Conduct — links to CODE_OF_CONDUCT.md and the enforcement contact
  • Ways to Contribute — quick-reference table covering bugs, features, docs, tests, and security
  • Getting Started — fork/clone, virtual env setup, editable install (pip install -e .), and smoke-test
  • Project Structure — annotated directory tree of the repo
  • Running Tests — single-command instructions (python test_comprehensive.py)
  • Coding Standards — PEP 8, type annotations (3.9+ syntax), get_logger usage, dependency policy
  • Commit Conventions — conventional-commit-style prefixes with examples (feat, fix, docs, test, refactor, chore, ci)
  • PR Process — step-by-step from branch creation to merge, with a note to open an issue before large changes
  • Bug Reporting / Feature Requests — issue checklists with required fields
  • Documentation — how to update the website and contributors.json
  • Security — pointer to SECURITY.md responsible-disclosure process

@0x5t4l1n
0x5t4l1n marked this pull request as ready for review April 8, 2026 18:25
@0x5t4l1n
0x5t4l1n merged commit 828dc38 into main Apr 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants