-
Notifications
You must be signed in to change notification settings - Fork 16.4k
Improve changelog descriptions in providers RC #60036
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve changelog descriptions in providers RC #60036
Conversation
Fix undescriptive notes and jargon in changelog.rst files modified by PR apache#59947. Changes are applied ONLY to the latest version in each provider: - Kubernetes 10.12.0: * Fix vague 'bug fix' description to proper PR title * Expand 'K8s' jargon to 'Kubernetes' - OpenLineage 2.9.2: * Remove 'nit:' prefix * Expand 'OL' jargon to 'OpenLineage' - Snowflake 6.8.1: * Remove inconsistent 'issue-XXXXX:' prefix * Fix grammar ('call the' -> 'call to') All other providers reviewed and found to be compliant with style guidelines.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR improves changelog descriptions in the latest version entries for three provider packages by removing unprofessional prefixes, expanding jargon, and fixing grammar issues to enhance readability and professionalism.
Key Changes:
- Removed unprofessional prefixes ("nit:", "issue-XXXXX:") from changelog entries
- Expanded abbreviations ("K8s" → "Kubernetes", "OL" → "OpenLineage") for clarity
- Fixed grammar errors and replaced vague descriptions with proper PR titles
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| providers/snowflake/docs/changelog.rst | Removed "issue-59385:" prefix and fixed grammar ("call the" → "call to") in version 6.8.1 misc entry |
| providers/openlineage/docs/changelog.rst | Removed "nit:" prefix and expanded "OL" to "OpenLineage" in version 2.9.2 misc entry |
| providers/cncf/kubernetes/docs/changelog.rst | Replaced vague "bug fix" with descriptive PR title and expanded "K8s" to "Kubernetes" in version 10.12.0 entries |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Just disabled Copilot auto-reviews for future PRs...sometimes it's just unuseful :D |
100% -> While sometimes is good and it finds issues I think "review" process should be very strongly human-driven -> you can use copilot locally - but exposing copilot's review as a comment for the contributor to address without human review is bad... Review is all about human interaction, not about finding issues. This is where people learn (both directions) from each other and establish relationships. |
…ly) (apache#60036) Fix undescriptive notes and jargon in changelog.rst files modified by PR apache#59947. Changes are applied ONLY to the latest version in each provider: - Kubernetes 10.12.0: * Fix vague 'bug fix' description to proper PR title * Expand 'K8s' jargon to 'Kubernetes' - OpenLineage 2.9.2: * Remove 'nit:' prefix * Expand 'OL' jargon to 'OpenLineage' - Snowflake 6.8.1: * Remove inconsistent 'issue-XXXXX:' prefix * Fix grammar ('call the' -> 'call to') All other providers reviewed and found to be compliant with style guidelines.
…ly) (apache#60036) Fix undescriptive notes and jargon in changelog.rst files modified by PR apache#59947. Changes are applied ONLY to the latest version in each provider: - Kubernetes 10.12.0: * Fix vague 'bug fix' description to proper PR title * Expand 'K8s' jargon to 'Kubernetes' - OpenLineage 2.9.2: * Remove 'nit:' prefix * Expand 'OL' jargon to 'OpenLineage' - Snowflake 6.8.1: * Remove inconsistent 'issue-XXXXX:' prefix * Fix grammar ('call the' -> 'call to') All other providers reviewed and found to be compliant with style guidelines.
Copilot Summary
Fix undescriptive notes and jargon in changelog.rst files modified by PR #59947. Changes are applied ONLY to the latest version in each provider:
^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named
{pr_number}.significant.rstor{issue_number}.significant.rst, in airflow-core/newsfragments.