docs: Add Code of Conduct link and EU funding logo to README#160
Conversation
WalkthroughA centered HTML image element displaying the Bundesministerium für Wirtschaft und Klimaschutz (BMWK)-EU funding logo was added to the README.md file under the "Licensing" section via an external image URL. No functional changes were made. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes 🚥 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. ✨ 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.
Pull request overview
This PR updates the repository README to surface community/process information and add an EU funding logo.
Changes:
- Adds an additional “Code of Conduct” section with a link to the org-wide Code of Conduct.
- Embeds an EU funding logo image at the bottom of the README.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## 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.
README already contains a “## Code of Conduct” section earlier in the file (lines ~21–23). This new duplicate section is likely unintended and makes the document inconsistent; consider merging the additional sentence/logo into the existing section instead of adding a second header.
|
|
||
| Copyright (20xx-)20xx SAP SE or an SAP affiliate company and <your-project> 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/checker). | ||
|
|
||
|
|
There was a problem hiding this comment.
There are two consecutive blank lines added before the new section header, which introduces extra vertical whitespace at the end of the README. If you keep this section, consider reducing to a single blank line to match the spacing used elsewhere in the file.
|
|
||
| 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.
The image alt text says “Bundesministerium für Wirtschaft und Energie (BMWE)” but the image filename is “BMWK-EU.png” (and the ministry name/acronym appears inconsistent). Please align the alt text with the actual logo/official naming 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> |
|
|
||
| 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.
The README hotlinks the funding logo from an external domain (apeirora.eu). This creates an availability/privacy dependency on a third-party host; consider checking the logo into the repo (or using a GitHub-hosted asset) and referencing it locally to make rendering deterministic.
| <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 Energie (BMWE)-EU funding logo" src="docs/assets/BMWK-EU.png" width="400"/></p> |
| ## 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.
PR description says it “adds a link to the Code of Conduct”, but the README already included a Code of Conduct section and link earlier. As-is, this change duplicates the existing link/section rather than introducing it for the first time; please reconcile the README content (and/or adjust the PR description) accordingly.
d593be5 to
dc134e3
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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 29: The README currently hotlinks the BMWK-EU logo via an external URL in
the <img> tag; add the logo file to the repository (e.g., docs/assets or
assets/img) and update the <img src="..."> reference in README.md to the new
relative path (preserve alt and width attributes), commit the image file and
updated README.md, and ensure the path is correct for both GitHub and any static
site build.
🪄 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: ASSERTIVE
Plan: Pro
Run ID: 0b9ca089-432b-4fa1-a6a0-caea37d4f1be
📒 Files selected for processing (1)
README.md
|
|
||
| Copyright (20xx-)20xx SAP SE or an SAP affiliate company and <your-project> 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/checker). | ||
|
|
||
| <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> |
There was a problem hiding this comment.
Avoid hotlinking external logo assets in README.
At Line 29, the logo is loaded from a third-party URL. This can break docs rendering if the remote file changes or disappears. Please commit the image into the repo and reference a relative path instead.
Proposed change
-<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>
+<p align="center"><img alt="Bundesministerium für Wirtschaft und Klimaschutz (BMWK)-EU funding logo" src="docs/assets/BMWK-EU.png" width="400"/></p>📝 Committable suggestion
‼️ 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.
| <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> | |
| <p align="center"><img alt="Bundesministerium für Wirtschaft und Klimaschutz (BMWK)-EU funding logo" src="docs/assets/BMWK-EU.png" width="400"/></p> |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` at line 29, The README currently hotlinks the BMWK-EU logo via an
external URL in the <img> tag; add the logo file to the repository (e.g.,
docs/assets or assets/img) and update the <img src="..."> reference in README.md
to the new relative path (preserve alt and width attributes), commit the image
file and updated README.md, and ensure the path is correct for both GitHub and
any static site build.
This PR adds a link to the Code of Conduct and the EU funding logo to the README.
Summary by CodeRabbit