[Docs] Add development test guidance #1520
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @Jeffwan, 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 primarily focuses on enhancing the developer documentation by providing more comprehensive and structured guidance for building, testing, and deploying the AIBrix project. The changes aim to clarify development workflows, detail various testing methodologies, and introduce new sections for local development environments and performance validation.
Highlights
- Comprehensive Testing Guidance: The documentation for development and testing has been significantly expanded and restructured, providing detailed instructions for unit, integration, and end-to-end tests, along with a new dedicated README for the testing framework.
- Enhanced Development Workflow: New sections have been added covering source code development, including building specific components, code generation, and code quality checks (linting), streamlining the developer experience.
- Improved Local Development Setup: Detailed guidance for a complete local development setup using Kind, including installation, port-forwarding, and uninstallation commands, has been introduced.
- Performance Regression Testing Documentation: A new section in the release documentation outlines the process and configurations for performance regression testing against release candidates.
Using Gemini Code Assist
The 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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.
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
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
|
@googs1025 please help check whether this aligns with your testing framework proposal |
There was a problem hiding this comment.
Code Review
This pull request significantly improves the development and testing documentation by restructuring the development guide, adding a comprehensive testing guide, and including details on performance regression testing. The changes are clear and valuable for contributors. My feedback includes a few minor formatting and clarity improvements to make the documentation even better.
|
LGTM overall. This is great for developers, as it gives us a clearer understanding. nit: I have a small question: can we quickly find these docs in README.md or CONTRIBUTING.md? 🤔 |
|
@googs1025 for readme.md under specific folder, I think no. it's not that easy. We can add some reference in root README.md. I also update development.rst in this PR, once it's merged, it will be shown here https://aibrix.readthedocs.io/latest/development/development.html |
Jeffwan
force-pushed
the
jiaxin/test-guidance
branch
from
18e1c1f to
6f6dc98
Compare
- Update test guidance in both test folder and official docs - Update development.rst structure Signed-off-by: Jiaxin Shan <[email protected]>
Jeffwan
force-pushed
the
jiaxin/test-guidance
branch
from
6f6dc98 to
72e4498
Compare
2 participants
Pull Request Description
Related Issues
Resolves: follow up of #1430
Important: Before submitting, please complete the description above and review the checklist below.
Contribution Guidelines (Expand for Details)
We appreciate your contribution to aibrix! To ensure a smooth review process and maintain high code quality, please adhere to the following guidelines:
Pull Request Title Format
Your PR title should start with one of these prefixes to indicate the nature of the change:
[Bug]: Corrections to existing functionality[CI]: Changes to build process or CI pipeline[Docs]: Updates or additions to documentation[API]: Modifications to aibrix's API or interface[CLI]: Changes or additions to the Command Line Interface[Misc]: For changes not covered above (use sparingly)Note: For changes spanning multiple categories, use multiple prefixes in order of importance.
Submission Checklist
By submitting this PR, you confirm that you've read these guidelines and your changes align with the project's contribution standards.