Clarify license and terms for contributions, reformat markdown #2546
Conversation
📝 WalkthroughWalkthroughThe changes update several documentation files by adding and reformatting content for clarity. A new "Community Contribution License" section has been introduced in the pull request template and in CONTRIBUTING.md (replacing the previous Developer Certificate of Origin section) to specify that contributions are licensed under Apache 2. Additionally, cosmetic formatting adjustments—such as added line breaks, consolidated text lines, and improved indentation—were applied in CODE_OF_CONDUCT.md, README.md, and devbox.md. There are no functional changes in the exported or public entities. Changes
Poem
🪧 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)
.github/pull_request_template.md (1)
11-12: Insert Missing Comma for Clarity.
To improve the sentence flow, consider adding a comma after "pull request".-By creating this pull request I represent that I have the right to license the +By creating this pull request, I represent that I have the right to license the🧰 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)
README.md (3)
60-62: Refine Redundant Wording.
Consider replacing “exact same” with “the same” for a more concise expression.-... gets a shell environment with the exact same version of those tools. +... gets a shell environment with the same version of those tools.🧰 Tools
🪛 LanguageTool
[style] ~62-~62: ‘exact same’ might be wordy. Consider a shorter alternative.
Context: ...oject gets a shell environment with the exact same version of those tools. ### Try new to...(EN_WORDINESS_PREMIUM_EXACT_SAME)
78-80: Correct Spelling of "Goodbye".
It’s more common to use “Goodbye” as one word.-### Good-bye conflicting versions +### Goodbye conflicting versions🧰 Tools
🪛 LanguageTool
[misspelling] ~78-~78: This word is normally spelled as one.
Context: ...valent container – but not before. ### Good-bye conflicting versions Are you working o...(EN_COMPOUNDS_GOOD_BYE)
186-187: Improve Sentence Punctuation.
Insert a comma before “so” to properly connect the independent clauses.-Devbox is an opensource project so contributions are always welcome. +Devbox is an opensource project, so contributions are always welcome.🧰 Tools
🪛 LanguageTool
[uncategorized] ~186-~186: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ibuting Devbox is an opensource project so contributions are always welcome. Pleas...(COMMA_COMPOUND_SENTENCE_2)
CONTRIBUTING.md (3)
6-7: Enhance Clarity with Proper Punctuation.
Consider inserting a comma immediately after “Please note” to clearly separate the introductory phrase.-Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in +Please note, we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in🧰 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)
39-43: Refine Error Message Explanation for Clarity.
Rephrase the error message block to remove the colon and improve readability. For example, consider:
"If you encounter an error likeline 3: command 'code' not found, it means you do not have the Visual Studio Code Shell Command installed. Follow the official guide at https://code.visualstudio.com/docs/setup/mac (see 'Launching from the command line') for installation instructions."-If you are encountering an error similar to: - `line 3: command 'code' not found`, this means you do not have the Visual - Studio Code "Shell Command" installed. To do this, follow the official guide: - https://code.visualstudio.com/docs/setup/mac. Please refer to the section - under: "Launching from the command line". +If you encounter an error like `line 3: command 'code' not found`, it means you do not have the Visual Studio Code Shell Command installed. Follow the official guide at https://code.visualstudio.com/docs/setup/mac (see "Launching from the command line") for installation instructions.🧰 Tools
🪛 LanguageTool
[typographical] ~39-~39: Do not use a colon (:) before a series that is introduced by a preposition (‘to’). Remove the colon or add a noun or a noun phrase after the preposition.
Context: ...f you are encountering an error similar to:line 3: command 'code' not found, t...(RP_COLON)
[style] ~41-~41: Consider a more expressive alternative.
Context: ...udio Code "Shell Command" installed. To do this, follow the official guide: http...(DO_ACHIEVE)
🪛 markdownlint-cli2 (0.17.2)
42-42: Bare URL used
null(MD034, no-bare-urls)
69-71: Elevate Language for Improved Professionalism.
Consider replacing “plan on making” with “intend to make” to adopt a more formal tone.- discuss what changes you plan on making. + discuss what changes you intend to make.🧰 Tools
🪛 LanguageTool
[style] ~70-~70: Try using a more formal synonym here to elevate your writing.
Context: ...an issue to discuss what changes you plan on making. This will let us help you with impl...(PLAN_ON_INTEND)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
.github/pull_request_template.md(1 hunks)CODE_OF_CONDUCT.md(1 hunks)CONTRIBUTING.md(3 hunks)README.md(8 hunks)devbox.md(2 hunks)
✅ Files skipped from review due to trivial changes (2)
- CODE_OF_CONDUCT.md
- devbox.md
🧰 Additional context used
🪛 LanguageTool
.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)
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)
[typographical] ~39-~39: Do not use a colon (:) before a series that is introduced by a preposition (‘to’). Remove the colon or add a noun or a noun phrase after the preposition.
Context: ...f you are encountering an error similar to: line 3: command 'code' not found, t...
(RP_COLON)
[style] ~41-~41: Consider a more expressive alternative.
Context: ...udio Code "Shell Command" installed. To do this, follow the official guide: http...
(DO_ACHIEVE)
[style] ~70-~70: Try using a more formal synonym here to elevate your writing.
Context: ...an issue to discuss what changes you plan on making. This will let us help you with impl...
(PLAN_ON_INTEND)
README.md
[style] ~62-~62: ‘exact same’ might be wordy. Consider a shorter alternative.
Context: ...oject gets a shell environment with the exact same version of those tools. ### Try new to...
(EN_WORDINESS_PREMIUM_EXACT_SAME)
[misspelling] ~78-~78: This word is normally spelled as one.
Context: ...valent container – but not before. ### Good-bye conflicting versions Are you working o...
(EN_COMPOUNDS_GOOD_BYE)
[style] ~93-~93: ‘exact same’ might be wordy. Consider a shorter alternative.
Context: ...u can build a production image with the exact same tools you used for development. - A r...
(EN_WORDINESS_PREMIUM_EXACT_SAME)
[uncategorized] ~186-~186: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ibuting Devbox is an opensource project so contributions are always welcome. Pleas...
(COMMA_COMPOUND_SENTENCE_2)
🪛 markdownlint-cli2 (0.17.2)
CONTRIBUTING.md
42-42: Bare URL used
null
(MD034, no-bare-urls)
98-98: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
98-98: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: golangci-lint (macos-13)
- GitHub Check: golangci-lint (ubuntu-latest)
- GitHub Check: build-devbox (macos-13)
- GitHub Check: Test Flake Build
🔇 Additional comments (3)
.github/pull_request_template.md (1)
5-10: New Licensing Section Added.
The addition of the "Community Contribution License" section clearly communicates the licensing terms for contributions. This update aligns well with the project's updated legal framework.README.md (1)
11-15: Updated Badges Section.
The refreshed badges with updated links and visuals enhance the document’s clarity and assist users in navigating key resources.CONTRIBUTING.md (1)
93-117: New Community Contribution License Section.
The newly added "Community Contribution License" section clearly specifies that all contributions are made under the Apache 2 License, replacing the previous Developer Certificate of Origin. This revision enhances clarity and consistency across documentation.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
98-98: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
98-98: Code block style
Expected: indented; Actual: fenced(MD046, code-block-style)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
README.md (2)
60-62: Configuration Instructions Formatting:
The instructions on usingdevbox.jsonand starting a shell are now more digestible.
Nitpick: The phrase “exact same version” could be simplified to “the same version” to reduce wordiness.🧰 Tools
🪛 LanguageTool
[style] ~62-~62: ‘exact same’ might be wordy. Consider a shorter alternative.
Context: ...oject gets a shell environment with the exact same version of those tools. ### Try new to...(EN_WORDINESS_PREMIUM_EXACT_SAME)
91-97: Bullet Point Clarity in Environment Options:
The bullet list illustrating various deployment options is well organized.
Nitpick: In the Dockerfile bullet point, consider replacing "exact same tools" with "the same tools" for brevity.🧰 Tools
🪛 LanguageTool
[style] ~93-~93: ‘exact same’ might be wordy. Consider a shorter alternative.
Context: ...u can build a production image with the exact same tools you used for development. - A r...(EN_WORDINESS_PREMIUM_EXACT_SAME)
CONTRIBUTING.md (1)
39-42: Shell Command Troubleshooting Tip:
The troubleshooting tip when encountering the error related to the VSCode shell command is very useful.
Refactor Suggestion: Consider rephrasing the sentence to avoid using a colon after “similar to”, as recommended by style guidelines. For example, remove the colon or add a noun phrase after “to”.🧰 Tools
🪛 LanguageTool
[typographical] ~39-~39: Do not use a colon (:) before a series that is introduced by a preposition (‘to’). Remove the colon or add a noun or a noun phrase after the preposition.
Context: .... - If you encounter an error similar to:line 3: command 'code' not found`, it ...(RP_COLON)
🪛 markdownlint-cli2 (0.17.2)
41-41: Bare URL used
null(MD034, no-bare-urls)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
.github/pull_request_template.md(1 hunks)CONTRIBUTING.md(3 hunks)README.md(8 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- .github/pull_request_template.md
🧰 Additional context used
🪛 LanguageTool
CONTRIBUTING.md
[typographical] ~39-~39: Do not use a colon (:) before a series that is introduced by a preposition (‘to’). Remove the colon or add a noun or a noun phrase after the preposition.
Context: .... - If you encounter an error similar to: line 3: command 'code' not found`, it ...
(RP_COLON)
README.md
[style] ~62-~62: ‘exact same’ might be wordy. Consider a shorter alternative.
Context: ...oject gets a shell environment with the exact same version of those tools. ### Try new to...
(EN_WORDINESS_PREMIUM_EXACT_SAME)
[style] ~93-~93: ‘exact same’ might be wordy. Consider a shorter alternative.
Context: ...u can build a production image with the exact same tools you used for development. - A r...
(EN_WORDINESS_PREMIUM_EXACT_SAME)
🪛 markdownlint-cli2 (0.17.2)
CONTRIBUTING.md
41-41: Bare URL used
null
(MD034, no-bare-urls)
97-97: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
97-97: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
⏰ Context from checks skipped due to timeout of 90000ms (25)
- GitHub Check: test-nix-versions (macos-13, 2.24.7)
- GitHub Check: test-nix-versions (macos-13, 2.19.2)
- GitHub Check: test-nix-versions (macos-13, 2.18.0)
- GitHub Check: test (not-main, ubuntu-latest, project-tests-off, 2.20.1)
- GitHub Check: test-nix-versions (macos-13, 2.17.0)
- GitHub Check: test (not-main, ubuntu-latest, project-tests-off, 2.19.2)
- GitHub Check: test-nix-versions (macos-13, 2.16.1)
- GitHub Check: test (not-main, ubuntu-latest, project-tests-off, 2.12.0)
- GitHub Check: test (not-main, ubuntu-latest, project-tests-only, 2.20.1)
- GitHub Check: test-nix-versions (macos-13, 2.15.1)
- GitHub Check: test (not-main, ubuntu-latest, project-tests-only, 2.19.2)
- GitHub Check: test-nix-versions (ubuntu-latest, 2.24.7)
- GitHub Check: test-nix-versions (ubuntu-latest, 2.19.2)
- GitHub Check: test (not-main, ubuntu-latest, project-tests-only, 2.12.0)
- GitHub Check: auto-nix-install (macos-13, false)
- GitHub Check: test-nix-versions (ubuntu-latest, 2.18.0)
- GitHub Check: auto-nix-install (macos-13, true)
- GitHub Check: test-nix-versions (ubuntu-latest, 2.17.0)
- GitHub Check: auto-nix-install (ubuntu-latest, false)
- GitHub Check: test-nix-versions (ubuntu-latest, 2.16.1)
- GitHub Check: test-nix-versions (ubuntu-latest, 2.15.1)
- GitHub Check: auto-nix-install (ubuntu-latest, true)
- GitHub Check: golangci-lint (macos-13)
- GitHub Check: golangci-lint (ubuntu-latest)
- GitHub Check: Test Flake Build
🔇 Additional comments (35)
README.md (21)
11-15: Good Badge Presentation:
The updated badges for Discord, License, Version, Tests, and "Built with Devbox" are now clearly formatted and provide concise calls to action.
19-22: Improved Readability for Description:
Breaking the introductory description into shorter lines improves readability without modifying the original message.
24-28: Clear Explanation of Devbox Functionality:
Formatting the explanation of how Devbox works like a package manager makes it easier to digest the information.
30-31: Project Origin Explanation:
The description regarding Devbox’s origin is now split across lines for clarity, making the information straightforward for the reader.
39-41: Example Environment Description:
The example explaining the creation of a development environment (with Python 2.7 and Go 1.18) is more legible with the new line breaks.
53-54: Documentation Link Clarity:
Splitting “Read more on the Devbox docs” into its own line alongside the link improves visual separation and focus.
66-69: Isolated Environment Benefits:
The reformatting clearly outlines the advantage of isolated environments, highlighting how tools can be added and removed without affecting the underlying system.
73-77: Enhanced Explanation of Speed and Containerization:
The revised block explains how Devbox creates isolated environments without extra virtualization effectively. The line breaks improve the flow of information.
78-83: Consistent Formatting for Managing Versions:
The section on “Goodbye conflicting versions” is now structured for clarity, detailing how isolation helps manage different versions of the same binary.
87-89: Portable Environment Advantages:
The brief explanation on the portability of Devbox environments is clearer with the adjusted line breaks.
100-103: Quickstart Introduction Clarity:
The quickstart introduction now succinctly explains the purpose and process of creating a development shell.
112-114: Commit Instructions Clarity:
The instruction to commit the newly createddevbox.jsonfile is clearly communicated.
123-125: Example Configuration Presentation:
The sampledevbox.jsonfile is well formatted, making it easy for contributors to understand the expected structure.
141-142: Visual Shell Indicator:
The note about identifying the Devbox shell through a changed prompt is clear and informative.
151-153: Regular Tools Accessibility:
The clarified description regarding the availability of regular tools (like environment variables and config settings) is helpful and well-formatted.
164-165: Quickstart Documentation Link Enhancement:
Breaking the “Read more on the Devbox docs Quickstart” phrase into two lines improves readability and draws proper attention to the link.
171-173: CLI Reference Link Formatting:
The new formatting for the CLI Reference link is clean and makes it easy for users to navigate to the full list of commands.
177-182: Community Engagement Section Improvement:
The community section now provides clearly formatted links for joining Discord, filing issues, and following Twitter updates.
186-187: Contributing Section Invitation:
The call-to-action for contributions, along with the link to the contributing guide, is now presented in a clear and accessible manner.
197-198: Translation Links Formatting:
The translation links are now listed in a clean, bullet-point format, making international documentation more accessible.
202-203: License Section Emphasis:
The license information is clearly highlighted, reaffirming the project’s open-source status under the Apache 2.0 License.CONTRIBUTING.md (14)
3-4: Contribution Guidelines Clarity:
The introductory lines now clearly instruct contributors to describe their changes via a related issue or pull request, setting the right expectations.
6-7: Code of Conduct Reminder:
Mentioning the code of conduct early on ensures that contributors are aware of the standards expected during interactions.
11-12: Development Environment Setup Reminder:
The guidance to install all required tools before making changes is clear and helps prevent setup issues.
27-28: CLI Build Instructions:
The instructions for building the Devbox CLI clearly note that Devbox will automatically install Nix if it isn’t already available.
36-37: VSCode Tip:
Including the tip to start VSCode from within the Devbox shell viadevbox run codeis a practical addition for developers.
46-47: Alternative Environment Setup Guidance:
The added instructions for manually replicating the environment if Devbox is unavailable are clear and provide valuable alternatives.
49-50: Nix Installer Recommendation:
The recommendation to use the Determinate Systems installer is well presented and helps streamline the setup process.
54-55: Alternative Installer Provision:
Providing a link to the official Nix installer as an alternative adds flexibility for users with different preferences.
68-70: Pull Request Process Clarification:
The revised pull request process, starting with filing an issue to discuss changes, is clearly explained and helps to avoid duplicate work.
71-72: Emphasis on Testing New Features:
Adding the requirement to include tests for new features ensures that contributions maintain a high level of quality.
79-82: Concise Style Guide Introduction:
The note that contributors need not be experts in Go, along with the assurance of reviewer support, makes the contribution process more approachable.
84-91: Go Language Resource List:
The bullet list linking to Effective Go and the Google Go Style Guide is informative and well-formatted, providing useful resources for contributors.
92-97: Community Contribution License Section:
Introducing the "Community Contribution License" section clarifies that all contributions must be made under the Apache 2 License, replacing the older Developer Certificate of Origin. This change aligns directly with the PR objectives for clearer contribution terms.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
97-97: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
97-97: Code block style
Expected: indented; Actual: fenced(MD046, code-block-style)
98-116: Licensing Certification Details:
The certification clause (with points a–d) is comprehensive and clear, ensuring that contributors understand their rights and obligations under the Apache 2 License. The improved formatting enhances the legibility of these important legal details.
…y-com#2546) ## 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 <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Introduced a new section detailing the licensing terms for community contributions under the Apache 2 License. - Updated contribution guidelines by replacing outdated certification details with the new licensing information. - Improved overall readability and formatting across community guidelines, the code of conduct, and other support documents for a clearer, more streamlined experience. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
…y-com#2546) ## 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 <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Introduced a new section detailing the licensing terms for community contributions under the Apache 2 License. - Updated contribution guidelines by replacing outdated certification details with the new licensing information. - Improved overall readability and formatting across community guidelines, the code of conduct, and other support documents for a clearer, more streamlined experience. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
…y-com#2546) ## 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 <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Introduced a new section detailing the licensing terms for community contributions under the Apache 2 License. - Updated contribution guidelines by replacing outdated certification details with the new licensing information. - Improved overall readability and formatting across community guidelines, the code of conduct, and other support documents for a clearer, more streamlined experience. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
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
Summary by CodeRabbit