Clarify license and terms for contributions, reformat markdown #448
Conversation
📝 WalkthroughWalkthroughThis pull request updates several documentation files by reformatting text for clarity and consistency. Changes include capitalizing "Apache 2 License," splitting long lines, and updating contribution guidelines. In multiple Changes
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (7)
README.md (1)
3-4: Nitpick: Consider hyphenating compound adjectives.
LanguageTool suggests that "open source projects" might be more clearly rendered as "open‐source projects" when used as a compound adjective. Please verify if this change aligns with the project's style guidelines.🧰 Tools
🪛 LanguageTool
[uncategorized] ~3-~3: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...t serves as the source of truth for all open source projects published by [jetify](https://...(EN_COMPOUND_ADJECTIVE_INTERNAL)
.github/pull_request_template.md (1)
11-11: Typographical Enhancement: Add Missing Comma.
It appears that a comma may be needed after the phrase "By creating this pull request I represent that I have the right to license the" to improve readability. Please consider inserting a comma at the appropriate place.🧰 Tools
🪛 LanguageTool
[typographical] ~11-~11: It appears that a comma is missing.
Context: ...NSE-2.0). By creating this pull request I represent that I have the right to lice...(BY_FOR_IN_COMMA)
typeid/typeid-js/CONTRIBUTING.md (1)
18-18: Typographical Enhancement: Consider Inserting a Comma.
A comma after the Apache 2 License reference in the sentence on line 18 may enhance readability. For example, "By contributing to this project, you agree..."🧰 Tools
🪛 LanguageTool
[uncategorized] ~18-~18: Possible missing comma found.
Context: ...s/LICENSE-2.0). By contributing to this project you agree to the terms stated in the [C...(AI_HYDRA_LEO_MISSING_COMMA)
typeid/typeid-go/CONTRIBUTING.md (1)
18-18: Typographical Enhancement: Inserting a Comma.
Consider adding a comma after the license URL on line 18 to improve the flow of the sentence. For instance: "By contributing to this project, you agree..."🧰 Tools
🪛 LanguageTool
[uncategorized] ~18-~18: Possible missing comma found.
Context: ...s/LICENSE-2.0). By contributing to this project you agree to the terms stated in the [C...(AI_HYDRA_LEO_MISSING_COMMA)
tyson/CONTRIBUTING.md (1)
6-7: Punctuation Improvement Suggestion
The sentence
“Please note we have a code of conduct, please follow it in all your interactions with the project.”
could be made clearer by adjusting the punctuation to better separate the two independent clauses.For example, you might consider the following diff:
-Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project. +Please note that we have a [code of conduct](CODE_OF_CONDUCT.md); please follow it in all your interactions with the project.🧰 Tools
🪛 LanguageTool
[uncategorized] ~6-~6: Possible missing comma found.
Context: ...lated issue, or a pull request. Please note we have a [code of conduct](CODE_OF_CON...(AI_HYDRA_LEO_MISSING_COMMA)
typeid/typeid/CONTRIBUTING.md (1)
6-7: Punctuation Improvement Suggestion
As with the other module, the line
“Please note we have a code of conduct, please follow it in all your interactions with the project.”
may benefit from a minor punctuation adjustment to separate the clauses more clearly.A suggested diff:
-Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project. +Please note that we have a [code of conduct](CODE_OF_CONDUCT.md); please follow it in all your interactions with the project.🧰 Tools
🪛 LanguageTool
[uncategorized] ~6-~6: Possible missing comma found.
Context: ...lated issue, or a pull request. Please note we have a [code of conduct](CODE_OF_CON...(AI_HYDRA_LEO_MISSING_COMMA)
CONTRIBUTING.md (1)
6-7: Punctuation Improvement Suggestion
Similar to the other files, the clause regarding the [code of conduct] would be clearer with adjusted punctuation.For clarity, consider this diff:
-Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project. +Please note that we have a [code of conduct](CODE_OF_CONDUCT.md); please follow it in all your interactions with the project.🧰 Tools
🪛 LanguageTool
[uncategorized] ~6-~6: Possible missing comma found.
Context: ...lated issue, or a pull request. Please note we have a [code of conduct](CODE_OF_CON...(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (9)
.github/pull_request_template.md(1 hunks)CODE_OF_CONDUCT.md(1 hunks)CONTRIBUTING.md(1 hunks)README.md(1 hunks)typeid/typeid-go/CONTRIBUTING.md(1 hunks)typeid/typeid-js/CONTRIBUTING.md(1 hunks)typeid/typeid-sql/CONTRIBUTING.md(1 hunks)typeid/typeid/CONTRIBUTING.md(1 hunks)tyson/CONTRIBUTING.md(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- CODE_OF_CONDUCT.md
🧰 Additional context used
🪛 LanguageTool
typeid/typeid-js/CONTRIBUTING.md
[uncategorized] ~6-~6: Possible missing comma found.
Context: ...lated issue, or a pull request. Please note we have a [code of conduct](CODE_OF_CON...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~18-~18: Possible missing comma found.
Context: ...s/LICENSE-2.0). By contributing to this project you agree to the terms stated in the [C...
(AI_HYDRA_LEO_MISSING_COMMA)
typeid/typeid-go/CONTRIBUTING.md
[uncategorized] ~18-~18: Possible missing comma found.
Context: ...s/LICENSE-2.0). By contributing to this project you agree to the terms stated in the [C...
(AI_HYDRA_LEO_MISSING_COMMA)
tyson/CONTRIBUTING.md
[uncategorized] ~6-~6: Possible missing comma found.
Context: ...lated issue, or a pull request. Please note we have a [code of conduct](CODE_OF_CON...
(AI_HYDRA_LEO_MISSING_COMMA)
typeid/typeid/CONTRIBUTING.md
[uncategorized] ~6-~6: Possible missing comma found.
Context: ...lated issue, or a pull request. Please note we have a [code of conduct](CODE_OF_CON...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~18-~18: Possible missing comma found.
Context: ...s/LICENSE-2.0). By contributing to this project you agree to the terms stated in the [C...
(AI_HYDRA_LEO_MISSING_COMMA)
typeid/typeid-sql/CONTRIBUTING.md
[uncategorized] ~18-~18: Possible missing comma found.
Context: ...s/LICENSE-2.0). By contributing to this project you agree to the terms stated in the [C...
(AI_HYDRA_LEO_MISSING_COMMA)
CONTRIBUTING.md
[uncategorized] ~6-~6: Possible missing comma found.
Context: ...lated issue, or a pull request. Please note we have a [code of conduct](CODE_OF_CON...
(AI_HYDRA_LEO_MISSING_COMMA)
.github/pull_request_template.md
[typographical] ~11-~11: It appears that a comma is missing.
Context: ...NSE-2.0). By creating this pull request I represent that I have the right to lice...
(BY_FOR_IN_COMMA)
README.md
[uncategorized] ~3-~3: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...t serves as the source of truth for all open source projects published by [jetify](https://...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
🔇 Additional comments (13)
typeid/typeid-sql/CONTRIBUTING.md (2)
3-4: Approval: Contribution Instructions are Clear.
The revised instructions about describing contributions via a related issue or pull request are concise and easy to follow.
16-19: Approval: Licensing Clause Update is Clear.
The updated clause now clearly requires that contributions are made under the terms of the Apache 2 License and the Community Contribution License. This change aligns well with the overall effort to standardize contribution guidelines.🧰 Tools
🪛 LanguageTool
[uncategorized] ~18-~18: Possible missing comma found.
Context: ...s/LICENSE-2.0). By contributing to this project you agree to the terms stated in the [C...(AI_HYDRA_LEO_MISSING_COMMA)
typeid/typeid-js/CONTRIBUTING.md (2)
3-4: Approval: Clear Contribution Instructions.
The guidance provided on how to describe the changes via an issue or pull request is straightforward and well-phrased.
16-19: Approval: Clear Licensing and Contribution Terms.
The update requiring contributions under the Apache 2 License and adherence to the Community Contribution License is clear, consistent, and effectively communicated.🧰 Tools
🪛 LanguageTool
[uncategorized] ~18-~18: Possible missing comma found.
Context: ...s/LICENSE-2.0). By contributing to this project you agree to the terms stated in the [C...(AI_HYDRA_LEO_MISSING_COMMA)
typeid/typeid-go/CONTRIBUTING.md (2)
3-4: Approval: Concise Contribution Guidance.
The introductory contribution instructions are clear and direct, making it simple for new contributors to understand the process.
16-19: Approval: Clear Licensing and Contribution Requirements.
The updated licensing terms explicitly state the requirement to contribute under the Apache 2 License while agreeing to the Community Contribution License, which is consistent with the repository’s revised guidelines.🧰 Tools
🪛 LanguageTool
[uncategorized] ~18-~18: Possible missing comma found.
Context: ...s/LICENSE-2.0). By contributing to this project you agree to the terms stated in the [C...(AI_HYDRA_LEO_MISSING_COMMA)
tyson/CONTRIBUTING.md (2)
3-4: Clear Contribution Instructions
The guidance on describing the change via a related issue or pull request is concise and straightforward.
16-19: License Terms Update Acknowledgment
The updated licensing section clearly states that contributions must be made under the terms of the [Apache 2 License] and references the [Community Contribution License]. This change aligns with the new project guidelines.typeid/typeid/CONTRIBUTING.md (2)
3-4: Clear Contribution Instructions
The request to describe the intended change via a related issue or pull request is clear and follows best practices.
16-19: Updated Licensing Terms
The licensing section now correctly indicates that contributions are made under the [Apache 2 License] and that contributors agree to the [Community Contribution License]. This update meets the PR objectives.🧰 Tools
🪛 LanguageTool
[uncategorized] ~18-~18: Possible missing comma found.
Context: ...s/LICENSE-2.0). By contributing to this project you agree to the terms stated in the [C...(AI_HYDRA_LEO_MISSING_COMMA)
CONTRIBUTING.md (3)
3-4: Clear Contribution Guidelines
The introductory lines inviting contributors to describe their changes via issues or pull requests are clear and maintain consistency with the other CONTRIBUTING files.
9-12: Updated License Header
The new section header “## Community Contribution License” clearly reflects the updated contribution policy. The licensing information with a link to the [Apache 2 License] is accurate and aligns with the PR objectives.
15-32: Enhanced Certification Criteria
The certification criteria enumerated from lines 15 through 32 are well organized and clearly outline the contributor’s responsibilities. This restructuring improves clarity over the previous Developer Certificate of Origin format.
LucilleH
left a comment
LucilleH
left a comment
There was a problem hiding this comment.
Why do we want 80 characters line in the code? We can adjust the display with DOM no?
| By creating this pull request I represent that I have the right to license the | ||
| contributions to the project maintainers under the Apache 2 license. | ||
| contributions to the project maintainers under the Apache 2 License as stated in | ||
| the |
Just to make sure we're on the same page: this isn't changing anything in terms of how the markdown is rendered. The newlines in the markdown are still interpreted as a space (they do not insert a line break in the rendered page). Markdown only inserts a new line when you have two line breaks in the source file (i.e. between paragraphs). So this change is only about reformatting the markdown "source code" and not the rendered result. |
2 participants
Summary
Tweaks several of our files to more clearly explain under what terms we accept contributions.
Reformat markdown files to fit under an 80 character width.
How was it tested?
N/A
Community Contribution License
All community contributions in this pull request are licensed to the project maintainers
under the terms of the Apache 2 license.
By creating this pull request I represent that I have the right to license the
contributions to the project maintainers under the Apache 2 license.
Summary by CodeRabbit