Skip to content

chore: establish community contribution process#755

Open
marythought wants to merge 1 commit intomainfrom
dspx-2421-community-process
Open

chore: establish community contribution process#755
marythought wants to merge 1 commit intomainfrom
dspx-2421-community-process

Conversation

@marythought
Copy link

Summary

  • Replaces the bare DCO-only CONTRIBUTING.md with a full community contribution guide
  • Adds Code of Conduct link (canonical CoC lives in opentdf/platform)
  • Documents community feedback channels (bugs → issues, features/questions → platform Discussions)
  • Adds contribution workflow, branch naming conventions, commit message format (Conventional Commits), and PR guidelines
  • Retains full DCO section unchanged

Test plan

  • Review rendered Markdown on GitHub
  • Verify all links resolve correctly

Closes DSPX-2421

@marythought marythought requested a review from a team as a code owner February 19, 2026 22:47
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @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 CONTRIBUTING.md file to establish a robust and clear community contribution process for the otdfctl repository. It aims to guide new and existing contributors through the entire lifecycle of engagement, from understanding the code of conduct and providing feedback to submitting well-structured code changes. The update standardizes development practices, making it easier for individuals to contribute effectively and for maintainers to review submissions.

Highlights

  • Comprehensive Contribution Guide: The existing DCO-only CONTRIBUTING.md has been replaced with a detailed community contribution guide, covering various aspects of engagement and code contribution.
  • Code of Conduct Integration: A link to the OpenTDF Code of Conduct has been added, ensuring contributors are aware of expected behavior.
  • Community Feedback Channels: Clear guidance is now provided on where to report bugs, request features, ask questions, and suggest documentation improvements, directing users to appropriate GitHub features like Issues and Discussions.
  • Standardized Contribution Workflow: New sections detail the contribution workflow, including steps for checking existing issues, aligning on approach, forking, branching, signing off commits, and opening pull requests.
  • Coding Standards and Guidelines: Specific guidelines for branch naming (e.g., feat/, fix/), commit message format (Conventional Commits), and pull request best practices have been introduced to maintain consistency.
  • Developer Certificate of Origin (DCO): The full DCO section has been retained and integrated into the new comprehensive guide, ensuring legal integrity of contributions.

🧠 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
  • CONTRIBUTING.md
    • Replaced the minimal DCO-only content with a comprehensive guide.
    • Added sections for Code of Conduct, Community Feedback, How to Contribute, Development Setup, Branch Naming, Commit Messages, and Pull Request Guidelines.
    • Integrated the existing Developer Certificate of Origin (DCO) content into the new structure.
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 significantly improves the CONTRIBUTING.md file by transforming it from a DCO-only document into a comprehensive guide for community contributions. The new content covers essential aspects such as the Code of Conduct, community feedback channels, a detailed contribution workflow, branch naming conventions, Conventional Commits format for commit messages, and clear pull request guidelines. The existing DCO section has been retained and slightly refined for better readability. This update is a valuable addition that will greatly assist new and existing contributors in understanding and adhering to the project's contribution standards.

@github-actions
Copy link

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 marythought force-pushed the dspx-2421-community-process branch from 6e79176 to f34d6f9 Compare February 20, 2026 01:13
@github-actions
Copy link

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.

1 participant