docs: Add Code of Conduct link and EU funding logo to README#161
docs: Add Code of Conduct link and EU funding logo to README#161jithinkunjachan merged 1 commit intomainfrom
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 changes add three lines to README.md. A blank line is inserted after the "Security / Disclosure" section heading. An HTML centered image element displaying the BMWK-EU funding logo is appended at the end of the README file, following the licensing information. The modifications are purely formatting and visual additions with no functional code changes. 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 |
There was a problem hiding this comment.
Pull request overview
This PR updates README.md to reference the project’s Code of Conduct and to display an EU funding logo.
Changes:
- Adds an additional “Code of Conduct” section/link at the end of the README.
- Embeds an EU funding logo image in the README.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
README already has a "## Code of Conduct" section earlier (lines 20–23), and this diff adds a second one, which will be confusing and makes the document harder to maintain. Please remove the duplicate section and, if needed, update the existing Code of Conduct section/link instead of adding a new header.
| ## 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). |
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.
This PR description says it "adds a link to the Code of Conduct", but the README already contained a Code of Conduct link above. As written, this change duplicates the link/section rather than adding it for the first time; please adjust the README change (or the PR description) so they match.
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.
The EU funding logo is embedded from an external site (apeirora.eu). If that host changes or is unavailable, the README will show a broken image; consider committing the logo into the repo (or otherwise using a stable canonical source) and referencing it relatively. Also, the logo probably belongs under a dedicated "Funding"/"Acknowledgements" section rather than under "Code of Conduct".
| ## 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 and Acknowledgements | |
| <p align="center"><img alt="Bundesministerium für Wirtschaft und Energie (BMWK)-EU funding logo" src="assets/BMWK-EU.png" width="400"/></p> |
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.
The image alt text references "(BMWE)" while the filename is "BMWK-EU.png"; please verify the intended ministry name/abbreviation and make the alt text consistent with the actual logo to avoid misinformation.
| <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 orbital 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/orbital). | ||
|
|
||
|
|
There was a problem hiding this comment.
There are two consecutive blank lines inserted before the new section. Consider keeping spacing consistent with the rest of the README (typically a single blank line between sections).
There was a problem hiding this comment.
🧹 Nitpick comments (1)
README.md (1)
28-29: Consider hosting the logo locally to reduce external dependency.The funding logo currently relies on an external URL from
apeirora.eu. While the URL is currently accessible, hosting the image directly in the repository improves reliability and eliminates the risk of breakage if the external domain or path changes.The image can be saved to
.github/images/BMWK-EU.pngand the README updated accordingly:Update to use local image
-<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=".github/images/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` around lines 28 - 29, Save the remote image currently referenced in README.md (the <img> tag with alt "Bundesministerium für Wirtschaft und Klimaschutz (BMWK)-EU funding logo") into the repo at .github/images/BMWK-EU.png, commit the file, and update the <img> element's src in README.md to point to the local relative path .github/images/BMWK-EU.png while preserving the alt text and width attribute; ensure the new path works in GitHub-rendered README and remove reliance on 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 28-29: Save the remote image currently referenced in README.md
(the <img> tag with alt "Bundesministerium für Wirtschaft und Klimaschutz
(BMWK)-EU funding logo") into the repo at .github/images/BMWK-EU.png, commit the
file, and update the <img> element's src in README.md to point to the local
relative path .github/images/BMWK-EU.png while preserving the alt text and width
attribute; ensure the new path works in GitHub-rendered README and remove
reliance on the external URL.
e4a86ac to
a3b77ed
Compare
This PR adds a link to the Code of Conduct and the EU funding logo to the README.
Summary by CodeRabbit
Documentation