Skip to content

Polish OSS contribution standards in CONTRIBUTING.md#1996

Merged
theyostalservice merged 2 commits intomainfrom
py/di-3578-polish-oss-contribution-standards
Mar 20, 2026
Merged

Polish OSS contribution standards in CONTRIBUTING.md#1996
theyostalservice merged 2 commits intomainfrom
py/di-3578-polish-oss-contribution-standards

Conversation

@theyostalservice
Copy link
Contributor

@theyostalservice theyostalservice commented Mar 19, 2026

Why

Our CONTRIBUTING.md lacked clear standards around contribution quality, which has led to increased review burden — PRs mixing concerns, missing tests, missing changelog entries, and interface changes arriving without prior discussion.

Closes DI-3578.

What

  • New section: "Before you write any code" — requires contributors to open a GitHub issue and discuss with the Semantic Layer engineering team before implementing any interface change (APIs, schemas, CLI commands, etc.). PRs without prior discussion on interface changes will be declined.
  • Lint is now a hard pre-PR requirement — reframed from "run at any time" to a blocking requirement, with CI enforcement called out explicitly.
  • Tests are required — added explicit callout that PRs adding behavior or fixing bugs must include tests; reviewers will ask for them if missing.
  • PR scope guidance strengthened — added bold callout that a PR should do one thing, with concrete heuristic ("also" / "while I was in here" = signal to split); added guidance to use commits to tell the story of a PR.
  • Rebase step clarified — replaced vague "merge your changes into your fork" with explicit git fetch upstream && git rebase upstream/main instruction.
  • Changelog timing fixed — corrected "once your PR is created" to "before opening your PR".

Notes

Paul Yang should do a final review and improvement pass per the Jira ticket.

Drafted by Claude Sonnet 4.6 under the direction of @theyostalservice

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@linear
Copy link

linear bot commented Mar 19, 2026

@cla-bot cla-bot bot added the cla:yes label Mar 19, 2026
@theyostalservice theyostalservice marked this pull request as ready for review March 19, 2026 23:30
@theyostalservice theyostalservice requested a review from a team as a code owner March 19, 2026 23:30
Copy link
Contributor

@plypaul plypaul left a comment

Choose a reason for hiding this comment

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

🚢

@theyostalservice theyostalservice merged commit cf13110 into main Mar 20, 2026
15 checks passed
@theyostalservice theyostalservice deleted the py/di-3578-polish-oss-contribution-standards branch March 20, 2026 16:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants