Skip to content

docs: update contributing; add clear boundaries for issues and prs#763

Merged
bupd merged 1 commit into
goharbor:mainfrom
qcserestipy:docs/contributing
Apr 7, 2026
Merged

docs: update contributing; add clear boundaries for issues and prs#763
bupd merged 1 commit into
goharbor:mainfrom
qcserestipy:docs/contributing

Conversation

@qcserestipy

Copy link
Copy Markdown
Collaborator

Closes #762

What changed

Rewrote steps 7–9 in CONTRIBUTING.md to clarify the contribution workflow and set expectations around PR quality.

Before

  • Steps 7–9 were a single "Push and Open a PR" step with a link, no guidance on issue-first workflow, PR quality, or AI-generated submissions.

After

  • Step 7 is now just "push to your fork" kept simple.
  • Step 8 makes explicit that a dedicated issue must be opened before a PR, giving maintainers a chance to provide early feedback. Includes a bold closure policy for PRs without linked issues.
  • Step 9 sets concrete PR expectations (what/why, test evidence, readable commits) and adds a note that AI-assisted work is welcome, but purely AI-generated drive-by PRs will be closed.

Why

  • Contributors sometimes open PRs without issues, which makes triage harder.
  • Low-effort AI-generated bulk PRs have been adding unnecessary review burden.
  • The previous wording didn't set any quality bar or explain the expected workflow clearly enough.

The tone stays welcoming the goal is to encourage thoughtful contributions, not discourage new contributors.

Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com>

@NucleoFusion NucleoFusion 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.

lgtm
Much needed change

@Vad1mo

Vad1mo commented Mar 20, 2026

Copy link
Copy Markdown
Member

Should we alo mention to research and look for existing issues and discussions prior creating a new issue and PR?

@bupd bupd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

/lgtm

@bupd

bupd commented Apr 7, 2026

Copy link
Copy Markdown
Member

Should we alo mention to research and look for existing issues and discussions prior creating a new issue and PR?

I believe we already do that at the start of the doc.

@bupd bupd merged commit eb6b9e1 into goharbor:main Apr 7, 2026
1 check passed
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.

[discussion]: clarify PR contribution process and set expectations around AI-generated submissions

4 participants