Skip to content

docs: move testing docs to contributors guide#123

Merged
holtskinner merged 1 commit intomainfrom
docs/testing-docs
Nov 19, 2025
Merged

docs: move testing docs to contributors guide#123
holtskinner merged 1 commit intomainfrom
docs/testing-docs

Conversation

@allen-stephen
Copy link
Collaborator

Summary

Move testing documentation from README to CONTRIBUTING.md to better organize contributor-focused content.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @allen-stephen, 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 refactors the project's documentation by relocating testing instructions from the general README.md to the more appropriate CONTRIBUTING.md file. This change aims to improve the organization and clarity of contributor-focused content, ensuring that developers looking to contribute can find all necessary information, including how to run tests, in a centralized location. The README.md is now streamlined to provide a concise overview for new users.

Highlights

  • Documentation Reorganization: The primary change involves moving the testing documentation from the main README.md file to the CONTRIBUTING.md file.
  • Improved Contributor Guide: The CONTRIBUTING.md file now includes a dedicated 'Testing' section with detailed instructions on how to run all tests, as well as separate commands for backend and frontend tests.
  • Streamlined README: The README.md file has been cleaned up by removing the testing instructions, making it more focused on project setup and usage rather than contributor guidelines.
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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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

  1. 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.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request moves the testing documentation from README.md to CONTRIBUTING.md. This is a good organizational change. My review focuses on improving the new documentation section in CONTRIBUTING.md by restoring a missing command necessary for running tests and by restructuring the content for better readability, making it more helpful for new contributors.

@holtskinner holtskinner merged commit 8098818 into main Nov 19, 2025
9 checks passed
@holtskinner holtskinner deleted the docs/testing-docs branch November 19, 2025 21:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Comments