Skip to content

feat: Add copilot instructions for pREST Go backend#967

Merged
arxdsilva merged 1 commit into
mainfrom
copilot-instructions
Jun 29, 2026
Merged

feat: Add copilot instructions for pREST Go backend#967
arxdsilva merged 1 commit into
mainfrom
copilot-instructions

Conversation

@arxdsilva

@arxdsilva arxdsilva commented Jun 29, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Documentation
    • Added repository-wide AI coding guidance to clarify project conventions, safety expectations, testing practices, and architecture rules.
    • Reinforces stable public behavior, idiomatic Go style, and careful handling of configuration, APIs, and database access.

@coderabbitai

coderabbitai Bot commented Jun 29, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: c7f28481-8bfa-4ad8-92ca-3dba75722964

📥 Commits

Reviewing files that changed from the base of the PR and between 8e2a0f8 and f46b651.

📒 Files selected for processing (1)
  • .github/copilot-instructions.md
📝 Walkthrough

Walkthrough

Adds .github/copilot-instructions.md with 94 lines of repository-wide AI contribution guidelines covering project scope, Go style, SQL safety, testing expectations, CLI/config conventions, performance, and architectural constraints.

Changes

Copilot Instructions

Layer / File(s) Summary
Repository-wide Copilot guidelines
.github/copilot-instructions.md		 New document defines project scope (Go 1.25.0, PostgreSQL REST), engineering principles, code organization rules, Go style, API/SQL safety constraints, testing expectations, config/CLI conventions, performance/reliability checks, documentation guidance, and layered architecture notes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

A rabbit wrote rules in a markdown file neat,
"No global state, wrap errors with %w,"
Keep SQL safe, let the tests stay complete,
Hexagonal layers from outside to inner view.
Hop along, Copilot — follow the beat! 🐇

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning No pull request description was provided, so the required summary and issue targeting details are missing. Add a PR description that explains the change and links any targeted issue, and remove the template text before posting.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly matches the change: adding Copilot instructions for the pREST Go backend.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch copilot-instructions

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

coderabbitai[bot]
coderabbitai Bot reviewed Jun 29, 2026
View reviewed changes

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@copilot-instructions.md`:
- Line 8: The repository version note is incorrect: the mention of go 1.20
conflicts with the actual Go version declared in go.mod. Update the Go version
statement in copilot-instructions.md so it matches the real module version (go
1.25.0), keeping the surrounding Language section consistent and accurate.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a5dd67b9-6160-444f-b611-7bde28b6499e

📥 Commits

Reviewing files that changed from the base of the PR and between b62662d and 8e2a0f8.

📒 Files selected for processing (1)
  • copilot-instructions.md

Comment thread copilot-instructions.md Outdated
@arxdsilva
arxdsilva force-pushed the copilot-instructions branch from 8e2a0f8 to f46b651 Compare June 29, 2026 22:42
@arxdsilva
arxdsilva merged commit e3f532c into main Jun 29, 2026
12 checks passed
@arxdsilva
arxdsilva deleted the copilot-instructions branch June 29, 2026 23:50
This was referenced Jun 30, 2026
Merged
Merged
Merged
Merged
@coderabbitai coderabbitai Bot mentioned this pull request Jul 15, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@arxdsilva