docs: add code of conduct, contributing guide, issue and PR templates#8
Conversation
There was a problem hiding this comment.
Pull request overview
Adds GitHub community health documentation and templates to standardize contributions and project governance for DeepZero.
Changes:
- Updates README project tagline/description.
- Adds
CONTRIBUTING.mdandCODE_OF_CONDUCT.mdwith development, testing, and community guidelines. - Introduces GitHub issue templates and a pull request template to improve report/PR quality.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Updates the project tagline/summary text. |
| CONTRIBUTING.md | Adds contributor workflow/setup, style, testing, and PR process guidance. |
| CODE_OF_CONDUCT.md | Adds a Contributor Covenant–based Code of Conduct with security-research addendum. |
| .github/pull_request_template.md | Adds a PR template with checklist and prompts. |
| .github/ISSUE_TEMPLATE/feature_request.md | Adds a feature request issue template. |
| .github/ISSUE_TEMPLATE/bug_report.md | Adds a bug report issue template. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | Change Type | Where | | ||
| |---|---| | ||
| | New built-in processor | `src/deepzero/stages/` + register in `__init__.py` | | ||
| | New community processor | `processors/<name>/` directory | | ||
| | New pipeline | `pipelines/<name>/` directory | |
There was a problem hiding this comment.
The "Types of Changes" table uses || at the start of each row, which renders as an extra empty column (or can break table formatting in some Markdown renderers). Use a single leading | per row (e.g., | Change Type | Where |) and update the separator/rows accordingly.
| - **GitHub**: Open a private report through the repository's security advisories | ||
| - **Email**: Contact a maintainer directly through the email listed on their | ||
| GitHub profile | ||
|
|
There was a problem hiding this comment.
The Code of Conduct report instructions currently direct people to open a private report via the repository’s Security Advisories, which is intended for security vulnerabilities and can misroute conduct incidents. Consider pointing to a dedicated maintainer contact method for CoC reports (e.g., an email alias) and/or GitHub’s built-in reporting guidance, and keep Security Advisories reserved for SECURITY.md.
| - **GitHub**: Open a private report through the repository's security advisories | |
| - **Email**: Contact a maintainer directly through the email listed on their | |
| GitHub profile | |
| - **Email**: Contact the maintainers at conduct@deepzero.dev | |
| - **GitHub**: For abuse or harassment on the GitHub platform, use GitHub's | |
| built-in reporting tools: https://docs.github.com/en/site-policy/acceptable-use-policies/github-reporting-and-appeals | |
| Please do not use the repository's security advisories for Code of Conduct | |
| reports; security advisories are reserved for vulnerability disclosures covered | |
| by our [Security Policy](SECURITY.md). |
No description provided.