Skip to content

Conversation

@mdxabu
Copy link
Member

@mdxabu mdxabu commented Nov 8, 2025

Added Community guidelines:

  • Added a CODE_OF_CONDUCT.md file outlining standards for respectful and inclusive behavior, unacceptable conduct, responsibilities of maintainers, scope of application, enforcement procedures, and attribution to the Contributor Covenant.

@mdxabu mdxabu added the documentation Improvements or additions to documentation label Nov 8, 2025
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @mdxabu, 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 introduces foundational documentation to guide and govern community interactions and contributions to the BHV project. By adding a Code of Conduct and detailed Contributing Guidelines, the project aims to cultivate a welcoming, inclusive, and efficient environment for all contributors, ensuring clarity on expectations and processes for participation.

Highlights

  • Code of Conduct Added: A new CODE_OF_CONDUCT.md file has been introduced, establishing clear guidelines for respectful and inclusive behavior within the project community. This document outlines pledges, standards of acceptable and unacceptable conduct, maintainer responsibilities, scope of application, and enforcement procedures, adapted from the Contributor Covenant.
  • Comprehensive Contributing Guidelines: A detailed CONTRIBUTING.md file has been added to guide new and existing contributors. It covers essential aspects such as setting up the development environment, various types of contributions, the development workflow, guidelines for creating issues and pull requests (including templates and conventional commit formats), code style, documentation practices, community interaction, and security vulnerability reporting.
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 adds important community health files: a Code of Conduct and Contributing Guidelines. This is a great step for the project! The documents are comprehensive and well-structured. I've provided some feedback to improve clarity, fix formatting issues, and ensure the instructions for contributors are accurate and easy to follow. Key suggestions include correcting the git workflow instructions, clarifying technical choices like the database, and fixing some markdown formatting.

Comment on lines 185 to 227
```markdown
## Problem Statement
Describe the problem this feature would solve.

## Proposed Solution
Describe your proposed solution.

## Alternatives Considered
What other approaches did you consider?

## Use Case
Who would benefit from this feature and how?

## Additional Context
Any other relevant information, mockups, or examples.

#### Documentation Issue Template

**Title Format**: `[DOCS] Brief description of documentation issue`

**Example**: `DOCS: Missing installation instructions for PostgreSQL`

#### Other Issue Types

- `[QUESTION]` - For questions about the project
- `[SECURITY]` - For security-related issues (see Security Policy)
- `[PERFORMANCE]` - For performance-related issues
- `[ACCESSIBILITY]` - For accessibility improvements
- `[REFACTOR]` - For code refactoring suggestions

### Issue Labels

Issues will be labeled by maintainers:
- `bug` - Something isn't working
- `enhancement` - New feature or request
- `documentation` - Documentation improvements
- `good first issue` - Good for newcomers
- `help wanted` - Extra attention needed
- `priority: high` - High priority
- `security` - Security-related
- `wontfix` - This will not be worked on

```
Copy link
Contributor

Choose a reason for hiding this comment

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

high

There's a formatting issue with the markdown code blocks in this section. The Feature Request Template code block starting on line 185 is not closed, which causes the subsequent sections (Documentation Issue Template, Other Issue Types, Issue Labels) to be rendered as part of the code block. The stray ```` on line 227 seems misplaced.

To fix this, you should:

  1. Add closing backticks (```) after line 199 to close the feature request template.
  2. Remove the stray backticks on line 227.

Comment on lines +369 to +370
- Use MongoDB for Database.
- Using Github Repo as a Database(Idea)
Copy link
Contributor

Choose a reason for hiding this comment

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

high

This section provides conflicting information about the database. It first states to Use MongoDB for Database. and then suggests Using Github Repo as a Database(Idea). This can be very confusing for new contributors. Please clarify which database technology is in use or intended to be used for the project.


## Attribution

This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html. No newline at end of file
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

The file is missing a final newline character. It's a common convention to end files with a newline to avoid issues with some tools and to follow POSIX standards.

Suggested change
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html.
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html.

### Recognition

We value all contributions! Contributors will be:
- Listed in our CONTRIBUTORS.md file
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

This line mentions a CONTRIBUTORS.md file, but this file does not exist in the repository. To avoid confusion, you should either create this file or remove this line from the recognition section.

mdxabu and others added 3 commits November 8, 2025 20:34
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@mdxabu mdxabu merged commit 9e502c9 into KathiraveluLab:main Nov 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant