docs: Add Code of Conduct link and EU funding logo to README#266
docs: Add Code of Conduct link and EU funding logo to README#266
Conversation
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
WalkthroughThe README.md was edited to change the "Requirements and Setup" placeholder text to use italicized formatting and to add an HTML-centered funding logo image (BMWK-EU) immediately after the "Licensing" section. No code or exported/public entities were modified. Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (2)
README.md (2)
29-31: Remove the duplicated “Code of Conduct” section heading.Line 29 duplicates the existing
## Code of Conductheading (Line 20), which triggers MD024 and makes the README structure redundant. Keep one Code of Conduct section and place new content under a different heading (for example, “Funding”).Proposed README fix
-## Code of Conduct - -To facilitate a nice environment for all, check out our [Code of Conduct](https://github.com/openkcm/.github/blob/main/CODE_OF_CONDUCT.md). +## Funding + +This project receives EU funding support.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 29 - 31, The README contains a duplicated section heading "## Code of Conduct" causing MD024; remove the redundant heading so only one "## Code of Conduct" remains and move or place any additional content intended for the second copy under a new heading (for example "## Funding"); update the file by deleting the duplicate "## Code of Conduct" line and ensuring any content that belonged there is relocated under the new heading.
33-33: Prefer a repository-hosted image over hotlinking.Using an externally hosted logo URL can make the README brittle if that host changes or is temporarily unavailable. Consider committing the logo under a docs/assets path and linking it relatively.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 33, Replace the hotlinked BMWK-EU.png URL in the README's <img> tag with a relative repository path and commit the image into the repo (e.g., add the file to docs/assets/BMWK-EU.png); update the src attribute in the existing <img> element to point to the new relative path (for example "docs/assets/BMWK-EU.png") so the README references the committed asset instead of the external URL.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@README.md`:
- Around line 29-31: The README contains a duplicated section heading "## Code
of Conduct" causing MD024; remove the redundant heading so only one "## Code of
Conduct" remains and move or place any additional content intended for the
second copy under a new heading (for example "## Funding"); update the file by
deleting the duplicate "## Code of Conduct" line and ensuring any content that
belonged there is relocated under the new heading.
- Line 33: Replace the hotlinked BMWK-EU.png URL in the README's <img> tag with
a relative repository path and commit the image into the repo (e.g., add the
file to docs/assets/BMWK-EU.png); update the src attribute in the existing <img>
element to point to the new relative path (for example
"docs/assets/BMWK-EU.png") so the README references the committed asset instead
of the external URL.
There was a problem hiding this comment.
Pull request overview
This PR updates the repository README to surface community/process info and acknowledgements by adding an additional Code of Conduct link section and an EU funding logo.
Changes:
- Adds a new “Code of Conduct” section with a link to the org-wide Code of Conduct.
- Embeds an EU funding logo image centered in the README.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
README.md
Outdated
|
|
||
| To facilitate a nice environment for all, check out our [Code of Conduct](https://github.com/openkcm/.github/blob/main/CODE_OF_CONDUCT.md). | ||
|
|
||
| <p align="center"><img alt="Bundesministerium für Wirtschaft und Energie (BMWE)-EU funding logo" src="https://apeirora.eu/assets/img/BMWK-EU.png" width="400"/></p> |
There was a problem hiding this comment.
Alt text says "(BMWE)" while the image filename/URL is "BMWK-EU.png". Please align the alt text (and abbreviation) with the actual logo to avoid misleading accessibility text.
| <p align="center"><img alt="Bundesministerium für Wirtschaft und Energie (BMWE)-EU funding logo" src="https://apeirora.eu/assets/img/BMWK-EU.png" width="400"/></p> | |
| <p align="center"><img alt="Bundesministerium für Wirtschaft und Klimaschutz (BMWK) – EU funding logo" src="https://apeirora.eu/assets/img/BMWK-EU.png" width="400"/></p> |
README.md
Outdated
|
|
||
| Copyright 2025 SAP SE or an SAP affiliate company and OpenKCM contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/openkcm/common-sdk). | ||
|
|
||
|
|
There was a problem hiding this comment.
There are two consecutive blank lines inserted after the Licensing section. Consider keeping to a single blank line to avoid excessive vertical whitespace in the rendered README.
README.md
Outdated
| ## Code of Conduct | ||
|
|
||
| To facilitate a nice environment for all, check out our [Code of Conduct](https://github.com/openkcm/.github/blob/main/CODE_OF_CONDUCT.md). | ||
|
|
||
| <p align="center"><img alt="Bundesministerium für Wirtschaft und Energie (BMWE)-EU funding logo" src="https://apeirora.eu/assets/img/BMWK-EU.png" width="400"/></p> |
There was a problem hiding this comment.
README already contains a "## Code of Conduct" section earlier (lines 20–22), so adding a second "## Code of Conduct" section here creates duplicate/contradictory guidance. Consider consolidating into the existing section and place the EU funding logo in a separate section (e.g., "Funding"/"Acknowledgements") if needed.
| ## Code of Conduct | |
| To facilitate a nice environment for all, check out our [Code of Conduct](https://github.com/openkcm/.github/blob/main/CODE_OF_CONDUCT.md). | |
| <p align="center"><img alt="Bundesministerium für Wirtschaft und Energie (BMWE)-EU funding logo" src="https://apeirora.eu/assets/img/BMWK-EU.png" width="400"/></p> | |
| ## Funding | |
| <p align="center"><img alt="Bundesministerium für Wirtschaft und Energie (BMWE)-EU funding logo" src="https://apeirora.eu/assets/img/BMWK-EU.png" width="400"/></p> |
README.md
Outdated
| ## Code of Conduct | ||
|
|
||
| To facilitate a nice environment for all, check out our [Code of Conduct](https://github.com/openkcm/.github/blob/main/CODE_OF_CONDUCT.md). |
There was a problem hiding this comment.
The PR description says it "adds a link to the Code of Conduct", but the README already links to the Code of Conduct earlier. If the intent is to change wording/placement, please update/remove the earlier section to avoid confusion, or adjust the PR description accordingly.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
README.md (1)
29-29: Prefer a repo-hosted logo instead of hotlinking an external asset.Line 29 depends on a third-party URL for README rendering. Hosting the image in this repository (or a controlled org asset location) improves long-term reliability and avoids external fetch dependency.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 29, Replace the external hotlinked image URL used in the README's <img src="https://apeirora.eu/assets/img/BMWK-EU.png" ...> with a repo-hosted copy: add the BMWK-EU.png file into the repository (e.g., assets/img/BMWK-EU.png), update the README's <img> tag (or Markdown image reference) to use the new relative path (assets/img/BMWK-EU.png), and commit both the image file and README change so the logo is served from the repo rather than the third-party URL.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Line 11: Replace the awkward placeholder text "Insert a short description what
is required to get your project running..." with clearer wording; update the
README placeholder to read "Insert a brief description of what is required to
get your project running..." so it uses natural grammar and clearer guidance for
contributors.
---
Nitpick comments:
In `@README.md`:
- Line 29: Replace the external hotlinked image URL used in the README's <img
src="https://apeirora.eu/assets/img/BMWK-EU.png" ...> with a repo-hosted copy:
add the BMWK-EU.png file into the repository (e.g., assets/img/BMWK-EU.png),
update the README's <img> tag (or Markdown image reference) to use the new
relative path (assets/img/BMWK-EU.png), and commit both the image file and
README change so the logo is served from the repo rather than the third-party
URL.
README.md
Outdated
| ## Requirements and Setup | ||
|
|
||
| *Insert a short description what is required to get your project running...* | ||
| _Insert a short description what is required to get your project running..._ |
There was a problem hiding this comment.
Tighten placeholder wording for clarity.
Line 11 reads a bit awkwardly (“description what is required”). Consider: “Insert a brief description of what is required to get your project running…”
🧰 Tools
🪛 LanguageTool
[style] ~11-~11: Consider using the synonym “brief” (= concise, using a few words, not lasting long) to strengthen your wording.
Context: .... ## Requirements and Setup _Insert a short description what is required to get you...
(QUICK_BRIEF)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` at line 11, Replace the awkward placeholder text "Insert a short
description what is required to get your project running..." with clearer
wording; update the README placeholder to read "Insert a brief description of
what is required to get your project running..." so it uses natural grammar and
clearer guidance for contributors.
jithinkunjachan
force-pushed
the
add-coc-and-eu-funding-logo
branch
from
d0e2aa0 to
a1ef31a
Compare
This PR adds a link to the Code of Conduct and the EU funding logo to the README.
Summary by CodeRabbit