-
Notifications
You must be signed in to change notification settings - Fork 400
docs: Governance proposed changes #6117
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
Conversation
Greptile OverviewGreptile SummaryThis PR updates Daft’s governance documentation to a new role ladder (Contributor → Maintainer/Read → Maintainer/Write → PMC) in One nav-related issue worth addressing: Confidence Score: 4/5
Important Files Changed
Sequence DiagramsequenceDiagram
participant Author as PR Author
participant Repo as Repository Docs
participant Contrib as CONTRIBUTING.md
participant Summary as docs/SUMMARY.md
participant Maint as docs/contributing/maintainers.md
participant Site as Docs Site (sidebar)
Author->>Contrib: Update governance model text
Author->>Contrib: Add link to maintainers page
Author->>Maint: Add Maintainers/Read, Maintainers/Write, PMC tables
Author->>Summary: Add Maintainers page to Contributing section
Site->>Summary: Build sidebar/navigation
Site->>Contrib: Render governance section + link
Site->>Maint: Render maintainers listings
Note over Summary,Site: Duplicate entries in SUMMARY can surface as repeated sidebar items
|
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.
3 files reviewed, 1 comment
Additional Comments (1)
Consider removing one of the two entries (or renaming one to point at a different example if that was intended). Prompt To Fix With AIThis is a comment left during a code review.
Path: docs/SUMMARY.md
Line: 66:71
Comment:
`docs/SUMMARY.md` currently includes the same page twice: `examples/voice-ai-analytics.md` appears at `Examples -> Voice AI Analytics with Faster-Whisper...` and again as `Examples -> Voice AI Analytics`. This PR moves the Contributing section but doesn’t address the duplicate entry; since SUMMARY drives nav generation, the duplicate can confuse users and make the sidebar look broken.
Consider removing one of the two entries (or renaming one to point at a different example if that was intended).
How can I resolve this? If you propose a fix, please make it concise. |
|
I'm very excited to hear that the governance structure of the Daft community has become clearer. We look forward to Daft thriving under the new governance model. |
|
That's great! As the governance model gradually improves, Daft will attract more and more community developers to join. One small suggestion: should we consider adding a selection mechanism for Contributors/Maintainers? For example, regularly using a voting mechanism to select contributors who have made outstanding contributions to Daft and nominate them as Maintainers? |
CONTRIBUTING.md
Outdated
| | [@aaron-ang](https://github.com/aaron-ang) | | Distance/similarity functions, string casing, list operations, SQL | | ||
| | [@Abyss-lord](https://github.com/Abyss-lord) | ctyun | Logger improvements | | ||
| | [@ConeyLiu](https://github.com/ConeyLiu) | Tencent | UTF-8 functions, regexp_replace, floor division | | ||
| | [@datanikkthegreek](https://github.com/datanikkthegreek) | Databricks | Delta Lake, Unity Catalog (issues & PRs) | | ||
| | [@destroyer22719](https://github.com/destroyer22719) | Queen's University | Expression aliases, documentation | | ||
| | [@djouallah](https://github.com/djouallah) | Microsoft | SQL/Spark ecosystem feedback | | ||
| | [@fenfeng9](https://github.com/fenfeng9) | | Embedding dtype fixes | | ||
| | [@gpathak128](https://github.com/gpathak128) | | JSON null field handling | | ||
| | [@hongbo-miao](https://github.com/hongbo-miao) | Archer Aviation | Installation, PyArrow, UUID support | | ||
| | [@ion-elgreco](https://github.com/ion-elgreco) | NATO | Ray execution, production feedback | | ||
| | [@j3nkii](https://github.com/j3nkii) | | Dashboard fixes, documentation | | ||
| | [@jakajancar](https://github.com/jakajancar) | Assertly | Catalog design, SQL features | | ||
| | [@kyo-tom](https://github.com/kyo-tom) | DTStack | OpenAI embedder token limits | | ||
| | [@lhoestq](https://github.com/lhoestq) | Hugging Face | HuggingFace ecosystem collaboration | | ||
| | [@Lucas61000](https://github.com/Lucas61000) | | SQL STRUCT parsing | | ||
| | [@malcolmgreaves](https://github.com/malcolmgreaves) | Meaves Industries | Documentation, tutorials, embeddings | | ||
| | [@rahulkodali](https://github.com/rahulkodali) | UT Austin | Multi-input hash function | | ||
| | [@shaofengshi](https://github.com/shaofengshi) | Datastrato | Apache Gravitino catalog integration | |
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.
was this autogenerated? some of these people have only made 1-2 contributions. I wouldn't necessarily call them official contributors just because of a one time PR. To me an official contributor would be contributions + consistency
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.
+1, a good variety of consistency, contributions, and issues
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.
I'm in favor of just removing this as it doesnt really add any value. it's just copy/paste of the public gh contributor data, and adds a maintenance burden to keep it up to date with anyone thats contributed.
If the goal is to show love to the regular contributors, there are better methods. For example, many OSS repos have a "top contributors" footer in the readme that's auto generated using gh actions.
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.
This makes sense, I did just scan the repository for contributors.
The "top contributors" method makes more sense, let's explore that approach instead.
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.
I feel that there is no need to list contributors separately in a maintenance document. A contributor means that anyone who has made a contribution can be called a contributor.
I think it is more meaningful to explain everyone's contributions to the community in each release note.
|
|
||
| ### Maintainer | ||
|
|
||
| A Maintainer is a recognized Contributor who has demonstrated sustained, meaningful contributions to the project. Maintainers are nominated by existing Maintainers or PMC members and approved by a majority vote of the PMC. |
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.
it may be a good time to formalize the path to becoming a maintainer too.
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.
I think the advanced path here can include two dimensions: one is contributing to major features, and the other is promoting and applying daft itself.
- A major feature might mean 40 PRs? Of course, this may be a non-mandatory rule. If the feature itself is particularly useful for daft, I think we can adopt a nomination mechanism.
- Promotion means maintaining a large cluster scale within the company and contributing to community promotion through various channels.
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.
I agree about formalizing this, but let's make this a follow-up instead rather than block the rest of the governance changes
CONTRIBUTING.md
Outdated
|
|
||
| A Maintainer is a recognized Contributor who has demonstrated sustained, meaningful contributions to the project. Maintainers are nominated by existing Maintainers or PMC members and approved by a majority vote of the PMC. | ||
|
|
||
| - **Maintainer/Read**: Recognized contributors with review (and approval) permissions, but without merge access |
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.
Suggest calling this "Maintainer (Reviewer)" or just "Reviewer" / similar, to better reflect this level. Read is confusing and more of an implementation detail.
CONTRIBUTING.md
Outdated
| A Maintainer is a recognized Contributor who has demonstrated sustained, meaningful contributions to the project. Maintainers are nominated by existing Maintainers or PMC members and approved by a majority vote of the PMC. | ||
|
|
||
| - **Maintainer/Read**: Recognized contributors with review (and approval) permissions, but without merge access | ||
| - **Maintainer/Write**: Maintainer/Read with merge access to the repository |
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.
Similarly, maybe we call this "Maintainer (Merge)" or just "Maintainer"?
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.
+1
CONTRIBUTING.md
Outdated
| - **Maintainer/Review**: Recognized contributors with review (and approval) permissions | ||
| - **Maintainer/Merge**: Maintainers additionally with merge access to the repository | ||
|
|
||
| **Maintainers/Read:** |
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.
**Maintainers/Read: --> **Maintainers/Review:
Corrected the section title from 'Maintainers/Read' to 'Maintainers/Review' and removed a contributor entry.
|
Thanks for chiming in everyone! We're merging this now and working on a broader announcement :) |
Changes Made
Contributor -> Maintainer/Review -> Maintainer/Merge -> PMCTODO:
Maintainer/Writemerge permissions to main.