Skip to content

Add AI guidelines and requirements. - #3064

Open
Rot127 wants to merge 3 commits into
capstone-engine:nextfrom
Rot127:a--guide
Open

Add AI guidelines and requirements.#3064
Rot127 wants to merge 3 commits into
capstone-engine:nextfrom
Rot127:a--guide

Conversation

@Rot127

@Rot127 Rot127 commented Sep 2, 2026

Copy link
Copy Markdown
Collaborator

Your checklist for this pull request

  • I've documented or updated the documentation of every API function and struct this PR changes.
  • I've added tests that prove my fix is effective or that my feature works (if possible)

Detailed description

  • Todo: Ask people to read the tests.

Adds AI guidelines.
They forbid contributors to write the PR descriptions with AI.

The hope is that:

  • People actually write it by hand.
    • In order to explain it, they have to understand the change.
    • In order to understand the change, they have to read it.
  • If they don't write it by hand, we have a rule at which we can point to, to request it. And in the worst case close the PR.

The problem is not huge. Because most contributors are professionals anyways.
Still, generated and incredible verbose PR descriptions were a problem before.
Because they eat a lot of time to read and understand.

Test plan

...

Closing issues

...

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟡 Changes recommended

The new guidelines include an inaccurate “exception below” reference and the PR template warning is formatted in a way that will leak into PR descriptions unless manually removed.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

Adds contributor-facing guidance around AI-assisted contributions and reinforces a requirement that PR descriptions must be authored by the contributor (not AI), by updating both the contributor guide and the PR template.

Changes:

  • Introduces an “AI guidelines” section in CONTRIBUTING.md.
  • Adds an AI-related warning banner at the top of the PR template, pointing readers to CONTRIBUTING.md.
File summaries
File Description
CONTRIBUTING.md Adds an “AI guidelines” section under contributor guidance.
.github/PULL_REQUEST_TEMPLATE.md Adds an AI warning block to the PR template header.
Review details
  • Files reviewed: 2/2 changed files
  • Comments generated: 2
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread .github/PULL_REQUEST_TEMPLATE.md
Comment thread CONTRIBUTING.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Github-files Github related files

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants