Skip to content

docs: Add Code of Conduct link and EU funding logo to README#161

Merged
jithinkunjachan merged 1 commit intomainfrom
add-coc-and-eu-funding-logo
Mar 31, 2026
Merged

docs: Add Code of Conduct link and EU funding logo to README#161
jithinkunjachan merged 1 commit intomainfrom
add-coc-and-eu-funding-logo

Conversation

@isanmaz
Copy link
Copy Markdown
Contributor

@isanmaz isanmaz commented Mar 23, 2026

This PR adds a link to the Code of Conduct and the EU funding logo to the README.

Summary by CodeRabbit

Documentation

  • Added BMWK-EU funding logo to the README.

Copilot AI review requested due to automatic review settings March 23, 2026 14:27
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 23, 2026

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 0fa88a10-2a29-4c1b-ae92-7cc20110ad0d

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Walkthrough

The 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

🐰 A Readme most fair,
With spacing to spare,
And a logo so bright,
With BMWK's light,
Makes documentation quite rare!

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The description is minimal but adequately conveys the purpose. However, it lacks the structured template sections (What/Why, Special notes, Release note) that are specified in the repository's template. Consider following the PR description template more closely by including structured sections for detailed explanation, reviewer notes, and release notes to improve clarity and consistency.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main changes: adding a Code of Conduct link and EU funding logo to README, which aligns with the actual file modifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ 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.

❤️ Share

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

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

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
Comment on lines +29 to +32
## 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).

Copy link

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

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

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.

Suggested change
## 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).

Copilot uses AI. Check for mistakes.
README.md Outdated
Comment on lines +29 to +31
## 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).
Copy link

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

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

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.

Copilot uses AI. Check for mistakes.
README.md Outdated
Comment on lines +28 to +33

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

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

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

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

Suggested change
## 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>

Copilot uses AI. Check for mistakes.
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>
Copy link

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

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

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.

Suggested change
<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>

Copilot uses AI. Check for mistakes.
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).


Copy link

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

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

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

Suggested change

Copilot uses AI. Check for mistakes.
apatsap
apatsap previously approved these changes Mar 23, 2026
@isanmaz isanmaz dismissed stale reviews from jithinkunjachan and apatsap via e4a86ac March 25, 2026 16:29
Copy link
Copy Markdown

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

🧹 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.png and 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.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: ab2ab8ee-5a9e-4aef-bdb0-b47daca09683

📥 Commits

Reviewing files that changed from the base of the PR and between 890c357 and e4a86ac.

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

@jithinkunjachan jithinkunjachan force-pushed the add-coc-and-eu-funding-logo branch from e4a86ac to a3b77ed Compare March 27, 2026 10:22
@jithinkunjachan jithinkunjachan merged commit 9a18019 into main Mar 31, 2026
10 checks passed
@jithinkunjachan jithinkunjachan deleted the add-coc-and-eu-funding-logo branch March 31, 2026 13:34
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.

5 participants