docs: update contributing conventions document#155
Conversation
Summary of ChangesHello, 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 a comprehensive set of contributing conventions to enhance consistency across the project's commit history, pull request titles, and branch names. By standardizing these elements, the aim is to improve code review quality, facilitate automated changelog generation, and support more efficient agentic workflows. The changes provide clear guidelines and examples for contributors to follow. 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 is a great addition to the project's documentation. The new contributing_conventions.md is thorough, well-structured, and provides clear guidance on commit, PR, and branch naming conventions, which will definitely improve consistency. The updates to CONTRIBUTING.md and .pages correctly integrate the new document. I have one minor suggestion to improve the clarity regarding the allowed types for branch names to avoid potential confusion.
gknapp1
left a comment
gknapp1
left a comment
There was a problem hiding this comment.
Nice addition. Just need to fix the broken CI for the docs deployment and a minor wording change.
liamnwhite1
force-pushed
the
docs/issue-154-contributing-conventions
branch
2 times, most recently
from
6dff2e5 to
9e02886
Compare
streeve
left a comment
streeve
left a comment
There was a problem hiding this comment.
Can you combine the two CONTRIBUTING and contributing_conventions files? They seem to endeavor to do the same thing.
I think we have one other top-level choice: 1) keep the level of detail you've added but understand it's aspirational (weakly enforced) 2) reduce the specificity and slowly add detail as we grow and/or get used to individual detail. For example, I don't know of any current emphasis on breaking changes that would warrant a contributing guideline
liamnwhite1
force-pushed
the
docs/issue-154-contributing-conventions
branch
from
9e02886 to
fc0eff0
Compare
|
@streeve The lastest push combines the files. Regarding adherence to these conventions, I think it should be weakly enforced initially for human contributors but it helps a lot to strongly enforce these things for agents. That's why the wording of these guidelines generally comes across as strict. I think it would be beneficial for us to have another meeting for me to better explain the reasoning behind some of the design decisions I'm making. I can also give you both a rough demo of an agentic workflow using Codex. |
| - Valid: `fix(metadata): handle missing layer-thickness field` | ||
| - Invalid: `fix(metadata): Fixed missing layer-thickness field` | ||
|
|
||
| ### Breaking Changes |
There was a problem hiding this comment.
Change: we need a description of what we mean by breaking (Breaking changes are considered to be anything that changes interfaces at the user level or substantive change to application behavior for a given set of inputs.
| ```bash | ||
| pip install -e .[dev] | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Clarification: do we need to explicitly state that step 2 is really "make your desired changes"
| - Valid: `fix(metadata): handle missing layer-thickness field` | ||
| - Invalid: `fix(metadata): Fixed missing layer-thickness field` | ||
|
|
||
| ### Breaking Changes |
There was a problem hiding this comment.
Change: we need some description of what we mean by breaking "breaking user examples, breaking developer interfaces, breaking default behavior, etc.)
docs/CONTRIBUTING.md
Outdated
|
|
||
| ### Description | ||
|
|
||
| - Use lowercase, hyphen-separated words. |
There was a problem hiding this comment.
Suggestion: I prefer underscores
streeve
changed the title
hotfix: currently unused with no current plans release: should be tag only
3 participants
Summary
Add and integrate a new contributor-facing conventions document that standardizes commit headers, PR titles, and branch naming using Conventional Commits style. A single conventions document improves consistency in history, changelogs, and PR review quality. Following these conventions also enahnces agentic workflows by allowing agents to search the codebase and its history more efficiently.
Related Issues/Pull Requests
Summary of Changes
docs/contributing_conventions.mdas the primary conventions guide.workflow,metadata,database,additivefoam,openfoam,exaca,peregrine, etc.).<type>(<scope1>, <scope2>): <description>CONTRIBUTING.mdto link todocs/contributing_conventions.md.docs/.pagesto includecontributing_conventions.mdin docs navigation.Testing
docs/contributing_conventions.md.docs/.pages.CONTRIBUTING.mdlinks to the new conventions doc.Documentation
docs/contributing_conventions.md.CONTRIBUTING.md.docs/.pages.Reviewer Focus Areas
Checklist