chore: establish community contribution process#845
Conversation
Summary of ChangesHello @marythought, 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 significantly enhances the 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
The pull request introduces a comprehensive community contribution guide, which is a significant improvement over the previous DCO-only document. It provides clear instructions on how to engage with the community, the development workflow, and standards for branches and commits. The adoption of Conventional Commits and standardized branch naming will help maintain a clean project history. My suggestions are minor and aimed at improving the formatting of the DCO instructions for better Git compatibility and ensuring the PR guidelines encourage local testing.
CONTRIBUTING.md
Outdated
| (see [Branch Naming](#branch-naming) below). | ||
| 4. **Make your changes**: follow the dev setup and code style below. | ||
| 5. **Sign off your commits**: see [DCO](#developer-certificate-of-origin-dco) below. | ||
| 6. **Open a pull request**: a [CODEOWNER](CODEOWNERS) will review and merge. |
There was a problem hiding this comment.
The term 'CODEOWNER' is singular here, but the file being linked is 'CODEOWNERS'. It is more conventional to refer to the 'code owners' or simply use the plural form to match the file name.
| 6. **Open a pull request**: a [CODEOWNER](CODEOWNERS) will review and merge. | |
| 6. **Open a pull request**: the [CODEOWNERS](CODEOWNERS) will review and merge. |
CONTRIBUTING.md
Outdated
| - Keep PRs focused — one logical change per PR is easier to review and revert. | ||
| - Update documentation for any interface or behavior changes. | ||
| - Ensure all CI checks pass before requesting review. | ||
| - Run `make lint` before pushing. |
There was a problem hiding this comment.
It is recommended to run tests locally before pushing to ensure that the changes do not break existing functionality, in addition to the linting check.
| - Run `make lint` before pushing. | |
| - Run make lint and make test before pushing. |
Replaces bare DCO-only CONTRIBUTING.md with a full guide covering code of conduct, community feedback channels, contribution workflow, branch naming, commit message format, PR guidelines, and DCO. Closes DSPX-2421 Signed-off-by: Mary Dickson <mary.dickson@virtru.com>
marythought
force-pushed
the
dspx-2421-community-process
branch
from
3791b3a to
1c7f6a9
Compare
1 participant
Summary
CONTRIBUTING.mdwith a full community contribution guideopentdf/platform)Test plan
Closes DSPX-2421