docs: update contributor policy, add contributing section, remove old… #5251
Conversation
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
Greptile Summary
This PR restructures the documentation by reorganizing the contributing guidelines into a more hierarchical and maintainable structure. The changes involve dividing the monolithic CONTRIBUTING.md file into focused, purpose-built documentation pages.
The main changes include:
-
Documentation Structure Reorganization: The navigation in
docs/SUMMARY.mdis updated to reflect a new nested structure where "Contributing" becomes a parent section with "Development Guide" as a subsection, replacing the previous flat structure. -
Creation of Dedicated Development Guide: A comprehensive new file
docs/contributing/development.mdis created containing detailed technical instructions for developers, including environment setup, debugging procedures with VSCode configuration, testing workflows, and a complete tutorial for adding new expressions to Daft with Rust implementation and Python bindings. -
Streamlined Main Contributing File: The root
CONTRIBUTING.mdis significantly simplified by removing ~366 lines of technical details and replacing them with a link to the new development guide. A new "Contributor Community" section is added defining four contributor roles (User, Contributor, Committer, Daft Punq) with clear progression paths and responsibilities. -
Index Page Conversion: The
docs/contributing/index.mdfile is converted from a symbolic link to actual content, providing a dedicated entry point for documentation contributors with issue reporting guidelines and feature proposal processes.
This restructuring follows common documentation patterns where high-level contributor information is separated from detailed technical instructions, making the content more accessible to different types of contributors and improving overall maintainability.
PR Description Notes:
- The PR description references external PDF attachments that show before/after views of the documentation
- The checklist indicates documentation builds properly and requests review from
@ccmao1130
Confidence score: 2/5
- This PR requires careful review due to potential navigation issues and incomplete file cleanup
- Score lowered due to an empty file (
docs/contributing-to-daft.md) that could break existing documentation links and missing navigation updates inmkdocs.yml - Pay close attention to
docs/contributing-to-daft.md(completely empty) and verifydocs/mkdocs.ymlnavigation is properly updated
5 files reviewed, 5 comments
| (Showing first 3 of 3 rows) | ||
| """ | ||
| # Get the function frou our global `FUNCTION_REGISTRY` |
There was a problem hiding this comment.
syntax: typo in comment: 'frou' should be 'from'
| # Get the function frou our global `FUNCTION_REGISTRY` | |
| # Get the function from our global `FUNCTION_REGISTRY` |
| ```py | ||
| def to_uppercase(self) -> Series: | ||
| return self._eval_expressions("upper") |
There was a problem hiding this comment.
logic: method name mismatch - calls '_eval_expressions("upper")' but function is named 'to_uppercase'
| return self._eval_expressions("upper") | |
| return self._eval_expressions("to_uppercase") |
There was a problem hiding this comment.
There was a problem hiding this comment.
Since your fn name returns "to_uppercase" that's how you would need to reference it. But actually I wouldn't want people to add new expression methods to Series, I'm actually planning on removing them in the future.
| 11. `make build-whl`: recompile your code after modifying any Rust code in `src/` for development, only generate `whl` file without installation | ||
| 12. `make daft-proto`: build Daft proto sources in `src/daft-proto` | ||
| ### Daft Committer | ||
| A committer is a developer who has consistently made meaningful contributions to the project and has been invited to this role based on the merit of their work. Committers are granted write access to specific parts of the code repository, have a signed committer agreement on file, and receive a daft.ai email address. With the ability to apply patches directly to code or documentation, they can make short-term decisions within their areas of expertise. These changes are then subject to review: the Daft Punks may approve them as permanent or choose to reject them. |
There was a problem hiding this comment.
syntax: Inconsistent naming: 'Daft Punks' is referenced in the Committer section but the actual section title is 'Daft Punqs'
| A committer is a developer who has consistently made meaningful contributions to the project and has been invited to this role based on the merit of their work. Committers are granted write access to specific parts of the code repository, have a signed committer agreement on file, and receive a daft.ai email address. With the ability to apply patches directly to code or documentation, they can make short-term decisions within their areas of expertise. These changes are then subject to review: the Daft Punks may approve them as permanent or choose to reject them. | |
| A committer is a developer who has consistently made meaningful contributions to the project and has been invited to this role based on the merit of their work. Committers are granted write access to specific parts of the code repository, have a signed committer agreement on file, and receive a daft.ai email address. With the ability to apply patches directly to code or documentation, they can make short-term decisions within their areas of expertise. These changes are then subject to review: the Daft Punqs may approve them as permanent or choose to reject them. |
There was a problem hiding this comment.
@jaychia @ccmao1130 Punks or Punqs?
3 participants
existing - Daft_CONTRIBUTING.md.pdf
existing-Contributing.pdf
new - subpage -Development Guide.pdf
new - Contributing to Daft.pdf
new - CONTRIBUTING.md - Grip.pdf
Changes Made
Related Issues
Checklist
docs/mkdocs.ymlnavigation