Skip to content

[WIP] Add community standards files for Go project#1

Merged
doITmagic merged 1 commit intomainfrom
copilot/add-community-standards-files
Nov 23, 2025
Merged

[WIP] Add community standards files for Go project#1
doITmagic merged 1 commit intomainfrom
copilot/add-community-standards-files

Conversation

Copy link
Contributor

Copilot AI commented Nov 23, 2025

Community Standards Files Creation

This PR adds GitHub Community Standards files to improve repository governance and contributor experience.

Plan:

  • Create CODE_OF_CONDUCT.md (Contributor Covenant 2.1)
  • Create CONTRIBUTING.md (Development guide with Go, Docker, Ollama prereqs)
  • Create SECURITY.md (Vulnerability reporting guide)
  • Create .github/ISSUE_TEMPLATE/bug_report.md
  • Create .github/ISSUE_TEMPLATE/feature_request.md
  • Create .github/PULL_REQUEST_TEMPLATE.md

All files will be customized for this Go project that uses Ollama, Qdrant, and Docker.

Original prompt

Create the following Community Standards files for the repository doITmagic/rag-code-mcp to meet GitHub's recommended community standards.

These files should be customized for a Go project that uses Ollama, Qdrant, and Docker.

1. CODE_OF_CONDUCT.md

Create this file in the root directory with the standard Contributor Covenant version 2.1 text.

2. CONTRIBUTING.md

Create this file in the root directory.
Content highlights:

  • Welcome message.
  • Prerequisites: Mention needing Go 1.25+, Docker, and Ollama installed for local development.
  • Development Process:
    1. Fork and clone.
    2. Create a branch.
    3. Make changes.
    4. Run tests: go test ./...
    5. Format code: gofmt -s -w .
    6. Submit PR.
  • Go Standards:
    • Code must be formatted with gofmt.
    • Code must pass go vet.
    • Public functions/types should have comments.
  • Pull Request Process:
    • Describe changes clearly.
    • Update documentation if needed.

3. SECURITY.md

Create this file in the root directory.
Content:

  • Supported Versions: current main branch.
  • Reporting: "Please do not report security vulnerabilities through public GitHub issues." instead "Use the 'Report a vulnerability' button on GitHub or email [maintainer email if known, otherwise generic '[email protected]' placeholder]." (Use a generic placeholder like maintainers or refer to the GitHub Security tab).

4. .github/ISSUE_TEMPLATE/bug_report.md

Create this file.
Content:

  • YAML header (name: Bug report, about: Create a report to help us improve, labels: bug).
  • Sections:
    • Describe the bug
    • To Reproduce (Steps)
    • Expected behavior
    • Screenshots
    • Environment (Crucial for this project):
      • OS:
      • Go Version:
      • Ollama Version:
      • Qdrant Status (running/stopped):
      • RagCode Version/Commit:
    • Logs

5. .github/ISSUE_TEMPLATE/feature_request.md

Create this file.
Content:

  • YAML header (name: Feature request, about: Suggest an idea, labels: enhancement).
  • Sections:
    • Is your feature request related to a problem?
    • Describe the solution you'd like
    • Describe alternatives you've considered
    • Additional context

6. .github/PULL_REQUEST_TEMPLATE.md

Create this file.
Content:

  • Description (Summary of changes).
  • Type of change (Bug fix, New feature, Breaking change, Documentation update).
  • Checklist:
    • My code follows the style guidelines of this project
    • I have performed a self-review of my own code
    • I have commented my code, particularly in hard-to-understand areas
    • I have made corresponding changes to the documentation
    • I have added tests that prove my fix is effective or that my feature works
    • New and existing unit tests pass locally with my changes

This pull request was created as a result of the following prompt from Copilot chat.

Create the following Community Standards files for the repository doITmagic/rag-code-mcp to meet GitHub's recommended community standards.

These files should be customized for a Go project that uses Ollama, Qdrant, and Docker.

1. CODE_OF_CONDUCT.md

Create this file in the root directory with the standard Contributor Covenant version 2.1 text.

2. CONTRIBUTING.md

Create this file in the root directory.
Content highlights:

  • Welcome message.
  • Prerequisites: Mention needing Go 1.25+, Docker, and Ollama installed for local development.
  • Development Process:
    1. Fork and clone.
    2. Create a branch.
    3. Make changes.
    4. Run tests: go test ./...
    5. Format code: gofmt -s -w .
    6. Submit PR.
  • Go Standards:
    • Code must be formatted with gofmt.
    • Code must pass go vet.
    • Public functions/types should have comments.
  • Pull Request Process:
    • Describe changes clearly.
    • Update documentation if needed.

3. SECURITY.md

Create this file in the root directory.
Content:

  • Supported Versions: current main branch.
  • Reporting: "Please do not report security vulnerabilities through public GitHub issues." instead "Use the 'Report a vulnerability' button on GitHub or email [maintainer email if known, otherwise generic '[email protected]' placeholder]." (Use a generic placeholder like maintainers or refer to the GitHub Security tab).

4. .github/ISSUE_TEMPLATE/bug_report.md

Create this file.
Content:

  • YAML header (name: Bug report, about: Create a report to help us improve, labels: bug).
  • Sections:
    • Describe the bug
    • To Reproduce (Steps)
    • Expected behavior
    • Screenshots
    • Environment (Crucial for this project):
      • OS:
      • Go Version:
      • Ollama Version:
      • Qdrant Status (running/stopped):
      • RagCode Version/Commit:
    • Logs

5. .github/ISSUE_TEMPLATE/feature_request.md

Create this file.
Content:

  • YAML header (name: Feature request, about: Suggest an idea, labels: enhancement).
  • Sections:
    • Is your feature request related to a problem?
    • Describe the solution you'd like
    • Describe alternatives you've considered
    • Additional context

6. .github/PULL_REQUEST_TEMPLATE.md

Create this file.
Content:

  • Description (Summary of changes).
  • Type of change (Bug fix, New feature, Breaking change, Documentation update).
  • Checklist:
    • My code follows the style guidelines of this project
    • I have performed a self-review of my own code
    • I have commented my code, particularly in hard-to-understand areas
    • I have made corresponding changes to the documentation
    • I have added tests that prove my fix is effective or that my feature works
    • New and existing unit tests pass locally with my changes

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI self-assigned this Nov 23, 2025
@doITmagic doITmagic marked this pull request as ready for review November 23, 2025 09:15
Copilot AI review requested due to automatic review settings November 23, 2025 09:15
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot wasn't able to review any files in this pull request.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@doITmagic doITmagic merged commit 15e3d74 into main Nov 23, 2025
2 of 3 checks passed
Copilot AI requested a review from doITmagic November 23, 2025 09:16
@doITmagic doITmagic deleted the copilot/add-community-standards-files branch November 23, 2025 09:57
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.

3 participants