docs(agents): document the copyright-header policy#754
Conversation
Add a Copyright headers section to AGENTS.md so future contributors (human or agent) attach the Andrii Berezovskyi / OSLC4Net contributors line when they significantly touch a file. Captures three rules that are easy to get wrong: - new files: line is the sole attribution - existing files with other attributions: append, never replace - existing files already carrying the line: leave the year alone Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
WalkthroughAGENTS.md adds a new "Copyright headers" section documenting when and how contributors should include copyright attributions for significantly modified files, with specific formatting rules for new files, existing files, year behavior, and guidance for preserving existing copyright lines. ChangesCopyright Headers Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 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 |
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 `@AGENTS.md`:
- Around line 119-121: The fenced code block containing "Copyright (c) <YYYY>
Andrii Berezovskyi and OSLC4Net contributors." lacks a language tag; update the
fence that surrounds that line (the triple backticks before/after the snippet)
to include a language identifier such as text (e.g., change ``` to ```text) so
markdown linting passes and docs checks are clean.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| ``` | ||
| Copyright (c) <YYYY> Andrii Berezovskyi and OSLC4Net contributors. | ||
| ``` |
There was a problem hiding this comment.
Add a language tag to the fenced code block.
Please specify a fence language (for example, text) to satisfy markdown linting and keep docs checks clean.
Proposed fix
-```
+```text
Copyright (c) <YYYY> Andrii Berezovskyi and OSLC4Net contributors.</details>
<!-- suggestion_start -->
<details>
<summary>📝 Committable suggestion</summary>
> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
```suggestion
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 119-119: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 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 `@AGENTS.md` around lines 119 - 121, The fenced code block containing
"Copyright (c) <YYYY> Andrii Berezovskyi and OSLC4Net contributors." lacks a
language tag; update the fence that surrounds that line (the triple backticks
before/after the snippet) to include a language identifier such as text (e.g.,
change ``` to ```text) so markdown linting passes and docs checks are clean.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #754 +/- ##
=======================================
Coverage 51.41% 51.41%
=======================================
Files 174 174
Lines 10401 10401
Branches 1057 1057
=======================================
Hits 5348 5348
Misses 4793 4793
Partials 260 260 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Per the policy in AGENTS.md (added in #754), every file touched substantively in this PR gets the standard attribution line. - IBaseClause.cs (new): sole attribution; the IBM 2013 header that was copy-pasted by mistake is replaced. - QueryUtils.cs, WhereClauseImpl.cs, SortTermsImpl.cs, QueryBasicTest.cs, Grammars/OslcWhere.g (modified): line appended after the existing IBM Corporation header; all other attributions and the Contributors block preserved. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Summary
Adds a Copyright headers section to
AGENTS.mdso future contributors (human or agent) know when and how to attach the standard attribution line:The rules captured in writing:
No code changes. Follow-up PRs will retroactively apply the line to files significantly touched in the currently open PRs (e.g. #363 and #491).
Test plan
AGENTS.mdand confirms the rules match the intended policyCLAUDE.mdsymlink and confirm the section renders the same🤖 Generated with Claude Code
Summary by CodeRabbit