chore: establish community contribution process

[marythought]

Summary

• Adds intro paragraph to CONTRIBUTING.md pointing to platform/CONTRIBUTING.md for general guidelines, branch naming, and commit conventions; existing Vale/Docusaurus content unchanged
• Adds a "Contributing" card to docs/introduction.mdx linking to platform/CONTRIBUTING.md

Test plan

• Review rendered Markdown on GitHub
• Verify Contributing card renders correctly on the docs site
• Verify all links resolve correctly

Closes DSPX-2421

[gemini-code-assist]

Summary of Changes

Hello @marythought, I'm Gemini Code Assist¹! 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 streamlines the contribution process for the OpenTDF project by centralizing general contribution guidelines and enhancing their visibility within the documentation. It ensures that all contributors are directed to a single source for overarching rules, while maintaining specific documentation contribution instructions where relevant. This change aims to provide a clearer and more consistent experience for anyone looking to contribute to the project.

Highlights

• Contribution Guidelines Centralization: The CONTRIBUTING.md file in the opentdf/docs repository has been updated to include an introductory paragraph that directs contributors to the main platform/CONTRIBUTING.md for general guidelines, branch naming, and commit conventions, while clarifying that the local file is specific to documentation contributions.
• Discoverability of Contribution Process: A new 'Contributing' card has been added to docs/introduction.mdx, providing a direct link to the centralized platform/CONTRIBUTING.md to improve the discoverability of the contribution process for users visiting the documentation site.

🧠 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
  • Updated the main heading to 'Contributing to opentdf/docs' to clarify its scope.
  • Added an introductory paragraph that thanks contributors and directs them to platform/CONTRIBUTING.md for general guidelines.
  • Clarified that the remaining content in this file is specific to documentation contributions.
• docs/introduction.mdx
  • Added a new card named 'Contributing' to the introduction page.
  • Included a description for the 'Contributing' card: 'Report bugs, request features, ask questions, or contribute code and docs. All community activity is welcome.'
  • Set the URL for the 'Contributing' card to https://github.com/opentdf/platform/blob/main/CONTRIBUTING.md.

Activity

• The pull request was created by marythought to establish a community contribution process.
• The author provided a summary of changes and a test plan in the pull request description.

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. ↩

[gemini-code-assist]

Code Review

The pull request effectively updates the CONTRIBUTING.md file to clarify the scope of contributions and adds a new 'Contributing' card to docs/introduction.mdx, improving navigation and guidance for contributors. The changes are straightforward and well-implemented.

[jp-ayyappan]

Do you think its worthwhile to do an ADR on the new community process? We discontinued Slack because it was becoming unmanageable. Do you have ideas of a process that might work best in async mode?

[marythought]

Do you think its worthwhile to do an ADR on the new community process? We discontinued Slack because it was becoming unmanageable. Do you have ideas of a process that might work best in async mode?

Yup, I was thinking the same. I think updating/standardizing these documents is a good first step but not the end.