feat: add contribution guidelines and templates#129
feat: add contribution guidelines and templates#129NJX-njx wants to merge 1 commit intoVersusControl:mainfrom
Conversation
- CONTRIBUTING.md with dev setup, coding standards, commit conventions - Pull request template - Issue templates: bug report, feature request, question - CODE_OF_CONDUCT.md (Contributor Covenant 2.1) - Security vulnerability reporting process Closes VersusControl#79 Made-with: Cursor
There was a problem hiding this comment.
Pull request overview
Adds community contribution infrastructure to the repository (guidelines, templates, and community standards) to support consistent external contributions and project governance.
Changes:
- Add
CONTRIBUTING.mdwith dev setup, coding standards, commit conventions, PR process, and security reporting guidance. - Add
CODE_OF_CONDUCT.mdbased on Contributor Covenant. - Add GitHub PR template and issue templates (bug/feature/question) plus issue template config.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| CONTRIBUTING.md | Adds contributor workflow and local dev/testing guidance, including security reporting section. |
| CODE_OF_CONDUCT.md | Introduces community conduct expectations and enforcement section. |
| .github/PULL_REQUEST_TEMPLATE.md | Standardizes PR submissions with a checklist and testing prompts. |
| .github/ISSUE_TEMPLATE/bug_report.md | Adds structured bug report template. |
| .github/ISSUE_TEMPLATE/feature_request.md | Adds structured feature request template. |
| .github/ISSUE_TEMPLATE/question.md | Adds question template intended for Discussions/issues. |
| .github/ISSUE_TEMPLATE/config.yml | Configures template selection and a Discussions contact link. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ## Enforcement | ||
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project maintainers. All complaints will be reviewed and investigated promptly and fairly. Project maintainers are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. |
There was a problem hiding this comment.
The Code of Conduct says to report incidents to “project maintainers” but doesn’t provide any contact method (email, form, or GitHub contact). Adding an explicit contact route is important so reports can be made consistently and privately.
| Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project maintainers. All complaints will be reviewed and investigated promptly and fairly. Project maintainers are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. | |
| Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project maintainers via email at conduct@example.com. All complaints will be reviewed and investigated promptly and fairly. Project maintainers are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. |
| # Run tests | ||
| go test ./... | ||
|
|
||
| # Build |
There was a problem hiding this comment.
The build command writes to bin/agent, but the repo doesn’t include a bin/ directory. As written, go build -o bin/agent ./cmd/agent will fail unless the user creates bin/ first. Consider adding mkdir -p bin or using an output path that always exists.
| # Build | |
| # Build | |
| mkdir -p bin |
| ## Pull Request Process | ||
|
|
||
| 1. Ensure your branch is up to date with `upstream/main`. | ||
| 2. Fill out the [PR template](.github/PULL_REQUEST_TEMPLATE.md). | ||
| 3. Link related issues (e.g., `Closes #123`). |
There was a problem hiding this comment.
Issue #79 acceptance criteria mentions documenting the release process and pre-commit hooks/local checks, but CONTRIBUTING.md currently stops at the PR process. Consider adding a short “Release process” section (e.g., tagging v* to trigger releases) and a “Pre-commit hooks / linting” section, and linking them from the Table of Contents.
| Please report security issues to the maintainers privately. Include: | ||
|
|
There was a problem hiding this comment.
The security reporting section asks reporters to contact maintainers privately, but it doesn’t provide a concrete reporting channel (e.g., security email address, or a link to GitHub Security Advisories/private vulnerability reporting). Without an explicit contact method, vulnerabilities may still be reported publicly or not reported at all.
| Please report security issues to the maintainers privately. Include: | |
| Please report security issues to the maintainers privately using GitHub Security Advisories: | |
| [https://github.com/VersusControl/ai-infrastructure-agent/security/advisories/new](https://github.com/VersusControl/ai-infrastructure-agent/security/advisories/new) | |
| When reporting, please include: |
|
|
||
| ## Checklist | ||
|
|
||
| - [ ] My code follows the project's [coding standards](../CONTRIBUTING.md#coding-standards) |
There was a problem hiding this comment.
The checklist link uses ../CONTRIBUTING.md#coding-standards. In PR descriptions, relative links are resolved from the repository root, so the ../ prefix can break navigation. Prefer a root-relative link like /CONTRIBUTING.md#coding-standards (or CONTRIBUTING.md#coding-standards).
| - [ ] My code follows the project's [coding standards](../CONTRIBUTING.md#coding-standards) | |
| - [ ] My code follows the project's [coding standards](CONTRIBUTING.md#coding-standards) |
Summary
Adds community contribution infrastructure per Task 1.12 (#79).
Changes
Closes #79
Made with Cursor