Add licence to README - #53
Conversation
Reviewer's guide (collapsed on small PRs)Reviewer's GuideAdds a licence section to the README documenting that Theoremc is distributed under the ISC licence. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
Add licence to READMEOverviewThis pull request adds a new "Licence" section to the README file, documenting that Theoremc is distributed under the ISC licence with a link to the licence text. Changes
ImpactNo changes to exported or public entities. This is a documentation-only update. WalkthroughThe PR adds a "Licence" section to the README documenting that Theoremc is distributed under the ISC licence, including a hyperlink to the full licence text. This is a straightforward documentation update with minimal scope. ChangesLicence Documentation
Poem
🚥 Pre-merge checks | ✅ 20✅ Passed checks (20 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![codescene-delta-analysis[bot]](https://avatars.githubusercontent.com/in/53921?s=60&v=4){kind=small}
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey - I've found 1 issue, and left some high level feedback:
- Consider aligning the spelling and casing of “Licence”/“license” with the rest of the project (e.g., LICENSE file name and existing docs) for consistency across the repository.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider aligning the spelling and casing of “Licence”/“license” with the rest of the project (e.g., LICENSE file name and existing docs) for consistency across the repository.
## Individual Comments
### Comment 1
<location path="README.md" line_range="50-53" />
<code_context>
mangling, and IO logic live in `crates/theoremc-core`. The root `theoremc`
crate re-exports both. Import paths from `theoremc` are unchanged.
+
+## Licence
+
+Theoremc is distributed under the
+[ISC licence](https://opensource.org/licenses/ISC).
</code_context>
<issue_to_address>
**suggestion (typo):** Consider aligning "Licence/licence" spelling with the rest of the project (e.g., "License") for consistency.
Both "Licence" and "licence" are valid British English, but many projects (and files like LICENSE) use "License". Please check how this term is used elsewhere in the repo and standardize on a single spelling (including headings and link text).
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| ## Licence | ||
|
|
||
| Theoremc is distributed under the | ||
| [ISC licence](https://opensource.org/licenses/ISC). |
There was a problem hiding this comment.
suggestion (typo): Consider aligning "Licence/licence" spelling with the rest of the project (e.g., "License") for consistency.
Both "Licence" and "licence" are valid British English, but many projects (and files like LICENSE) use "License". Please check how this term is used elsewhere in the repo and standardize on a single spelling (including headings and link text).
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Line 53: Remove the trailing space at the end of the "[ISC
licence](https://opensource.org/licenses/ISC)" line in README.md so the line
ends with the closing parenthesis (no trailing whitespace), fixing the MD009
markdownlint failure and unblocking CI.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| ## Licence | ||
|
|
||
| Theoremc is distributed under the | ||
| [ISC licence](https://opensource.org/licenses/ISC). |
There was a problem hiding this comment.
Remove trailing whitespace on Line 53 to unblock CI.
Delete the single trailing space at the end of the licence link line; the
current content fails markdownlint (MD009) and breaks the CI quality gate.
Triage: [type:syntax/md]
Patch
-Theoremc is distributed under the
-[ISC licence](https://opensource.org/licenses/ISC).
+Theoremc is distributed under the
+[ISC licence](https://opensource.org/licenses/ISC).As per coding guidelines, "**/*.md: Markdown paragraphs and bullet points
must be wrapped at 80 columns" and markdown syntax/lint requirements must be
followed, including valid whitespace handling.
🧰 Tools
🪛 GitHub Actions: CI / 0_build-test.txt
[error] 53-53: markdownlint-cli2/markdownlint MD009/no-trailing-spaces: Trailing spaces [Expected: 0 or 2; Actual: 1]
🪛 GitHub Actions: CI / build-test
[error] 53-53: markdownlint-cli2 (markdownlint v0.38.0) failed: MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1].
🪛 GitHub Check: build-test
[failure] 53-53: Trailing spaces
README.md:53:52 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md009.md
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` at line 53, Remove the trailing space at the end of the "[ISC
licence](https://opensource.org/licenses/ISC)" line in README.md so the line
ends with the closing parenthesis (no trailing whitespace), fixing the MD009
markdownlint failure and unblocking CI.
Sources: Coding guidelines, Linters/SAST tools, Pipeline failures
1 participant
Summary by Sourcery
Documentation: