-
Notifications
You must be signed in to change notification settings - Fork 27
Docs: Add Contributing Guidelines and Code of Conduct #3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Summary of ChangesHello @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
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
|
There was a problem hiding this 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.
| ```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 | ||
|
|
||
| ``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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:
- Add closing backticks (```) after line 199 to close the feature request template.
- Remove the stray backticks on line 227.
| - Use MongoDB for Database. | ||
| - Using Github Repo as a Database(Idea) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
CODE_OF_CONDUCT.md
Outdated
|
|
||
| ## 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
| 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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>
Added Community guidelines:
CODE_OF_CONDUCT.mdfile outlining standards for respectful and inclusive behavior, unacceptable conduct, responsibilities of maintainers, scope of application, enforcement procedures, and attribution to the Contributor Covenant.