Skip to content

docs(agents): document the copyright-header policy#754

Merged
berezovskyi merged 1 commit into
mainfrom
chore/agents-copyright-policy
May 17, 2026
Merged

docs(agents): document the copyright-header policy#754
berezovskyi merged 1 commit into
mainfrom
chore/agents-copyright-policy

Conversation

@berezovskyi
Copy link
Copy Markdown
Member

@berezovskyi berezovskyi commented May 17, 2026

Summary

Adds a Copyright headers section to AGENTS.md so future contributors (human or agent) know when and how to attach the standard attribution line:

Copyright (c) <YYYY> Andrii Berezovskyi and OSLC4Net contributors.

The rules captured in writing:

  • New files — line is the sole attribution.
  • Existing files with other attributions (e.g. the IBM Corporation header) — append after the last existing copyright line; never replace.
  • Existing files already carrying the line — leave the year alone; don't "refresh" it.
  • Never remove other copyright attributions.

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

  • Reviewer reads the new section in AGENTS.md and confirms the rules match the intended policy
  • Open the file via the CLAUDE.md symlink and confirm the section renders the same

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated contributor documentation with new copyright header guidelines providing clear guidance on how to properly insert copyright attributions in significantly modified files, including standards for attribution text formatting, year handling conventions, and detailed procedures for adding new contributor information alongside existing copyright notices.

Review Change Stack

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>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 17, 2026

Walkthrough

AGENTS.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.

Changes

Copyright Headers Documentation

Layer / File(s) Summary
Copyright headers guidelines
AGENTS.md
New section specifies copyright line insertion requirements, formatting for new vs. existing files, year handling rules, and rules for adding contributor attributions alongside existing copyright statements.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

A rabbit hops through copyright lines so clear, ✏️
Adding guidance for contributors near and far,
Headers adorned with years and names so dear,
OSLC4Net shines like a collaborative star! ⭐

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely summarizes the main change: documenting a copyright-header policy in AGENTS.md documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/agents-copyright-policy

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: a5ca0ffe-e8ac-444e-90d7-00cae6e03498

📥 Commits

Reviewing files that changed from the base of the PR and between 544ace0 and 6f6e1e5.

📒 Files selected for processing (1)
  • AGENTS.md

Comment thread AGENTS.md
Comment on lines +119 to +121
```
Copyright (c) <YYYY> Andrii Berezovskyi and OSLC4Net contributors.
```
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

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
Copy link
Copy Markdown

codecov Bot commented May 17, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 51.41%. Comparing base (544ace0) to head (6f6e1e5).

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

berezovskyi added a commit that referenced this pull request May 17, 2026
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>
@berezovskyi berezovskyi added this pull request to the merge queue May 17, 2026
Merged via the queue into main with commit bf086ce May 17, 2026
10 checks passed
@berezovskyi berezovskyi deleted the chore/agents-copyright-policy branch May 17, 2026 14:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant