Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
berezovskyi merged 1 commit into from
May 17, 2026
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,31 @@ dotnet format whitespace ./OSLC4Net_SDK && dotnet format style ./OSLC4Net_SDK --
- Also run this **after resolving merge conflicts**. Hand-edited hunks re-introduce style drift even when both parents were clean.
- A pre-commit hook (`.pre-commit-config.yaml`) enforces this; install once with `pre-commit install`.

## Copyright headers

Any file you've **significantly** touched (substantive code, docs, or
non-trivial test changes — not just whitespace, renames, or a one-line
tweak) should carry the line:

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

@coderabbitai coderabbitai Bot May 17, 2026

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.


where `<YYYY>` is the current year **at the time you add the line**.

Rules:
- **New files**: include this line as the sole copyright attribution (no
inherited IBM/contributor headers).
- **Existing files** that already have other copyright attributions
(e.g. `Copyright (c) 2012 IBM Corporation.`): add the
`Andrii Berezovskyi and OSLC4Net contributors.` line immediately after
the last existing copyright line. Preserve all other attributions and
the `Contributors:` block.
- **Existing files** that already carry an
`Andrii Berezovskyi and OSLC4Net contributors.` line: leave the year
alone. Do not "refresh" it to the current year.
- Never remove other copyright attributions.

## Project Structure

- `OSLC4Net_SDK/` - Main SDK projects (.NET 10)
Expand Down
Loading