docs: simplify contributing guide#131
Conversation
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
Summary of ChangesHello @bniladridas, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request streamlines the project's contributing guide by significantly reducing its content. The primary goal is to clarify that contributions are currently restricted to collaborators, providing them with essential workflow and build instructions while removing extensive, detailed guidelines that are no longer relevant for external contributors. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request simplifies the CONTRIBUTING.md file, aligning with the decision to currently not accept external contributions. While the goal of a minimal guide for collaborators is understandable, the current version omits crucial information regarding environment setup and build processes. This could create friction for new collaborators joining the project. My review includes suggestions to reintroduce this essential information in a concise manner, leveraging the existing Makefile to simplify instructions and improve consistency.
|
|
||
| Thank you for your interest in contributing to Llamaware. This guide outlines how to set up your environment, follow coding standards, and submit contributions. | ||
| This project is currently maintained by collaborators. External contributions are not accepted at this time. | ||
|
|
There was a problem hiding this comment.
The previous contributing guide included instructions for installing dependencies, which are essential for any new collaborator setting up their development environment. Removing this information makes onboarding more difficult. Please consider adding a 'Setup' section that points to the Makefile targets for dependency installation, as they provide a simple, automated way to get started.
| ## Setup | |
| Before building, install the required dependencies for your platform using the `Makefile`: | |
| - **macOS:** `make install-deps-mac` | |
| - **Ubuntu:** `make install-deps-ubuntu` |
| ## Building | ||
|
|
||
| ```bash | ||
| # Configure | ||
| cmake -S . -B build -DCMAKE_BUILD_TYPE=Release | ||
|
|
||
| # Build | ||
| cmake --build build --config Release | ||
|
|
||
| # Run tests | ||
| cmake --build build --target test | ||
|
|
||
| # Run preflight | ||
| make preflight | ||
| ``` |
There was a problem hiding this comment.
The Makefile provides simpler, high-level targets for building and testing. The collaborator guidelines already refer to make preflight. To maintain consistency and simplify the process for developers, it would be better to use these make targets in the build instructions instead of raw cmake commands.
| ## Building | |
| ```bash | |
| # Configure | |
| cmake -S . -B build -DCMAKE_BUILD_TYPE=Release | |
| # Build | |
| cmake --build build --config Release | |
| # Run tests | |
| cmake --build build --target test | |
| # Run preflight | |
| make preflight | |
| ``` | |
| ## Building | |
| Use the `Makefile` for common development tasks: | |
| ```bash | |
| # Build the project | |
| make build | |
| # Run tests | |
| make test | |
| # Run pre-flight checks before pushing changes | |
| make preflight |
1 participant
Made CONTRIBUTING.md minimal - now states collaborators only with basic build instructions