-
Notifications
You must be signed in to change notification settings - Fork 68
feat: add contribution guidelines and templates #129
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| --- | ||
| name: Bug Report | ||
| about: Report a bug or unexpected behavior | ||
| title: '[BUG] ' | ||
| labels: bug | ||
| assignees: '' | ||
| --- | ||
|
|
||
| ## Description | ||
|
|
||
| <!-- A clear and concise description of the bug --> | ||
|
|
||
| ## Steps to Reproduce | ||
|
|
||
| 1. | ||
| 2. | ||
| 3. | ||
|
|
||
| ## Expected Behavior | ||
|
|
||
| <!-- What you expected to happen --> | ||
|
|
||
| ## Actual Behavior | ||
|
|
||
| <!-- What actually happened --> | ||
|
|
||
| ## Environment | ||
|
|
||
| - **OS**: (e.g., Windows 11, macOS 14, Ubuntu 22.04) | ||
| - **Go version**: `go version` | ||
| - **AI provider**: (e.g., OpenAI, Gemini, Anthropic) | ||
| - **AWS region**: (if applicable) | ||
|
|
||
| ## Logs / Error Messages | ||
|
|
||
| ``` | ||
| <!-- Paste relevant logs or error output --> | ||
| ``` | ||
|
|
||
| ## Additional Context | ||
|
|
||
| <!-- Any other context, screenshots, or config snippets --> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| blank_issues_enabled: true | ||
| contact_links: | ||
| - name: Discussions | ||
| url: https://github.com/VersusControl/ai-infrastructure-agent/discussions | ||
| about: Ask questions or share ideas |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| --- | ||
| name: Feature Request | ||
| about: Suggest a new feature or enhancement | ||
| title: '[FEATURE] ' | ||
| labels: enhancement | ||
| assignees: '' | ||
| --- | ||
|
|
||
| ## Problem Statement | ||
|
|
||
| <!-- Describe the problem or use case this feature would address --> | ||
|
|
||
| ## Proposed Solution | ||
|
|
||
| <!-- Describe the feature you'd like to see --> | ||
|
|
||
| ## Alternatives Considered | ||
|
|
||
| <!-- Any alternative solutions or approaches you've considered --> | ||
|
|
||
| ## Additional Context | ||
|
|
||
| <!-- AWS services involved, AI provider, etc. --> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| --- | ||
| name: Question | ||
| about: Ask a question about the project | ||
| title: '[QUESTION] ' | ||
| labels: question | ||
| assignees: '' | ||
| --- | ||
|
|
||
| ## Question | ||
|
|
||
| <!-- Your question here --> | ||
|
|
||
| ## Context | ||
|
|
||
| <!-- Any relevant context (what you're trying to do, what you've tried, etc.) --> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| ## Summary | ||
|
|
||
| <!-- Brief description of the changes --> | ||
|
|
||
| ## Type of Change | ||
|
|
||
| - [ ] Bug fix (non-breaking change that fixes an issue) | ||
| - [ ] New feature (non-breaking change that adds functionality) | ||
| - [ ] Breaking change (fix or feature that would cause existing functionality to change) | ||
| - [ ] Documentation update | ||
| - [ ] Other (please describe): | ||
|
|
||
| ## Related Issues | ||
|
|
||
| <!-- Link to related issues, e.g. Closes #123 --> | ||
|
|
||
| ## Changes Made | ||
|
|
||
| <!-- List the main changes --> | ||
|
|
||
| - | ||
| - | ||
| - | ||
|
|
||
| ## Testing | ||
|
|
||
| <!-- Describe how you tested your changes --> | ||
|
|
||
| - [ ] Ran `go test ./...` | ||
| - [ ] Manual testing (describe below) | ||
|
|
||
| ## Checklist | ||
|
|
||
| - [ ] My code follows the project's [coding standards](../CONTRIBUTING.md#coding-standards) | ||
| - [ ] I have run `gofmt` and `go vet` | ||
| - [ ] I have added/updated tests as needed | ||
| - [ ] I have updated documentation if applicable | ||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,33 @@ | ||||||
| # Contributor Covenant Code of Conduct | ||||||
|
|
||||||
| ## Our Pledge | ||||||
|
|
||||||
| We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. | ||||||
|
|
||||||
| We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. | ||||||
|
|
||||||
| ## Our Standards | ||||||
|
|
||||||
| Examples of behavior that contributes to a positive environment: | ||||||
|
|
||||||
| * Using welcoming and inclusive language | ||||||
| * Being respectful of differing viewpoints and experiences | ||||||
| * Gracefully accepting constructive criticism | ||||||
| * Focusing on what is best for the community | ||||||
| * Showing empathy towards other community members | ||||||
|
|
||||||
| Examples of unacceptable behavior: | ||||||
|
|
||||||
| * The use of sexualized language or imagery, and sexual attention or advances of any kind | ||||||
| * Trolling, insulting or derogatory comments, and personal or political attacks | ||||||
| * Public or private harassment | ||||||
| * Publishing others' private information without explicit permission | ||||||
| * Other conduct which could reasonably be considered inappropriate in a professional setting | ||||||
|
|
||||||
| ## 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. | ||||||
|
||||||
| 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. |
| Original file line number | Diff line number | Diff line change | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,131 @@ | ||||||||||||
| # Contributing to AI Infrastructure Agent | ||||||||||||
|
|
||||||||||||
| Thank you for your interest in contributing! This document provides guidelines for contributing to the AI Infrastructure Agent project. | ||||||||||||
|
|
||||||||||||
| ## Table of Contents | ||||||||||||
|
|
||||||||||||
| - [Code of Conduct](#code-of-conduct) | ||||||||||||
| - [Getting Started](#getting-started) | ||||||||||||
| - [Development Environment Setup](#development-environment-setup) | ||||||||||||
| - [Coding Standards](#coding-standards) | ||||||||||||
| - [Commit Message Conventions](#commit-message-conventions) | ||||||||||||
| - [Pull Request Process](#pull-request-process) | ||||||||||||
| - [Reporting Security Vulnerabilities](#reporting-security-vulnerabilities) | ||||||||||||
|
|
||||||||||||
| ## Code of Conduct | ||||||||||||
|
|
||||||||||||
| This project adheres to the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. | ||||||||||||
|
|
||||||||||||
| ## Getting Started | ||||||||||||
|
|
||||||||||||
| 1. **Fork the repository** and clone your fork locally. | ||||||||||||
| 2. **Create a branch** for your work: `git checkout -b feat/your-feature-name` or `fix/your-bug-fix`. | ||||||||||||
| 3. **Make your changes** following our [coding standards](#coding-standards). | ||||||||||||
| 4. **Run tests** before submitting: `go test ./...` | ||||||||||||
| 5. **Submit a pull request** using our [PR template](.github/PULL_REQUEST_TEMPLATE.md). | ||||||||||||
|
|
||||||||||||
| ## Development Environment Setup | ||||||||||||
|
|
||||||||||||
| ### Prerequisites | ||||||||||||
|
|
||||||||||||
| - **Go 1.24+** – [Install Go](https://golang.org/doc/install) | ||||||||||||
| - **Docker** (optional) – For containerized runs | ||||||||||||
| - **AWS credentials** – For testing AWS operations (use a dev account or localstack) | ||||||||||||
|
|
||||||||||||
| ### Setup Steps | ||||||||||||
|
|
||||||||||||
| ```bash | ||||||||||||
| # Clone your fork | ||||||||||||
| git clone https://github.com/YOUR_USERNAME/ai-infrastructure-agent.git | ||||||||||||
| cd ai-infrastructure-agent | ||||||||||||
|
|
||||||||||||
| # Add upstream remote | ||||||||||||
| git remote add upstream https://github.com/VersusControl/ai-infrastructure-agent.git | ||||||||||||
|
|
||||||||||||
| # Install dependencies | ||||||||||||
| go mod download | ||||||||||||
|
|
||||||||||||
| # Run tests | ||||||||||||
| go test ./... | ||||||||||||
|
|
||||||||||||
| # Build | ||||||||||||
|
||||||||||||
| # Build | |
| # Build | |
| mkdir -p bin |
Copilot
AI
Mar 3, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Copilot
AI
Mar 3, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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(orCONTRIBUTING.md#coding-standards).