Initial definition of a PR policy - #267
Open
chargio wants to merge 6 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Introduces an RFC documenting an updated pull request policy (including AI-assisted contribution expectations), and wires it into the developer documentation navigation while adjusting the contribution template guidance on PR size.
Changes:
- Added RFC 0007 describing an updated PR workflow/policy (triage rules, automation gate, template, reviewer guidance).
- Linked the new RFC from the developer docs navigation.
- Updated CONTRIBUTING template guidance to express PR size in “lines of code” wording.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 7 comments.
| File | Description |
|---|---|
| trento-docs-site/modules/developer/nav_developer.adoc | Adds nav entry pointing to the new RFC 0007. |
| content/templates/CONTRIBUTING.adoc | Updates PR size guidance wording to “500 lines of code”. |
| content/rfc/0007-updated-pr-policy.adoc | New RFC defining updated PR policy/workflow, automation gate, and templates. |
Suppressed comments (2)
content/rfc/0007-updated-pr-policy.adoc:106
- This section title refers to
CONTRIBUTION.adoc, but the existing contribution guide in this repo isCONTRIBUTING.adoc(and this PR updates that file).
=== Addition of CONTRIBUTION.adoc file
content/rfc/0007-updated-pr-policy.adoc:120
- This refers to
CONTRIBUTION.adoc, but the repo usesCONTRIBUTING.adoc(noCONTRIBUTION.adocexists).
We will follow the Linux Foundation's AI Code of Conduct and the Open Source Initiative's AI Guidelines to ensure that all contributions, whether internal or external, meet the project's quality standards and maintain the integrity of the codebase. For that reason, we will add the following section to the CONTRIBUTION.adoc file:
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| == Considerations | ||
| The following considerations should be added to the code standards. Whenever possible, they also should be included in the workflows to create PR (for instance, with specific templates, pre-commit hooks, and CI/CD checks). | ||
|
|
||
| In general, code contributors and reviewers should follow the guidelines outlined in `CONTRIBUTION.adoc`. |
|
|
||
| Trento is an open-source project that values community contributions, and at the same time is used as the core for commercially available solutions intended for use in high stakes production environments. Although the use of AI-generated code is welcomed, in some cases it has raised concerns about code quality, maintainability, and security. This RFC aims to establish a clear and consistent pull request policy that applies to all contributors, ensuring that the project remains robust and reliable, and open to anybody willing to contribute. | ||
|
|
||
| The amount of time spent by maintainers reviewing low-quality or AI-generated code has increased significantly later, which has led to delays in merging contributions and a decrease in overall project efficiency. By implementing a pre-review automation gate and establishing clear guidelines for pull requests, we can reduce the burden on maintainers and ensure that only high-quality contributions are reviewed and merged. |
|
|
||
| == Updated Pull Request Workflow (for reviewers) | ||
|
|
||
| === Step 0: Initial assigment |
|
|
||
| Changes in dependencies due to deprecated versions or changes of API will require manual update and intervention by the maintainers. Minor updates that do not introduce breaking changes can be handled more efficiently, but still require verification to ensure compatibility and stability. | ||
|
|
||
| === When a Larg PR is ok? |
| * *discussion _(optional)_* - This contains supporting statements, context, reasoning, and anything else to help communicate the “why” and “next steps” for resolving the comment. | ||
|
|
||
| .Labels used | ||
| [width="100%",cols="<18%s,<82%", ] |
| Code or other content generated in whole or in part using AI tools can be contributed to Trento. However, there are some unique considerations related to AI generated content that developers should factor into their contributions. | ||
|
|
||
| Contributors should ensure that the terms and conditions of the generative AI tool do not place any contractual restrictions on how the tool’s output can be used that are inconsistent with the project’s open source software license, the project’s intellectual property policies, or the Open Source Definition. | ||
| If any pre-existing copyrighted materials (including pre-existing open source code) authored or owned by third parties are included in the AI tool’s output, prior to contributing such output to the project, the Contributor should confirm that they have have permission from the third party owners–such as the form of an open source license or public domain declaration that complies with the project’s licensing policies–to use and modify such pre-existing materials and contribute them to the project. Additionally, the contributor should provide notice and attribution of such third party rights, along with information about the applicable license terms, with their contribution. |
Comment on lines
+191
to
+195
| GitHub allows to wrap your code in a suggestion block. By wrapping code in a suggestion block, you provide an exact replacement that the author can apply with a single click: | ||
|
|
||
| ```suggestion | ||
| this is my new suggestion | ||
| ``` |
chargio
marked this pull request as ready for review
September 2, 2026 08:01
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Add a description of the required changes in documentation to address the needs for better PR requests and reviews.
This document describes the changes that will need to be implemented.
Fixes #
How was this tested?
Document only
Documentation changes
Yes
Additional information