docs: Add Code of Conduct link and EU funding logo to README#153
docs: Add Code of Conduct link and EU funding logo to README#153
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 pull request modifies the README.md file to improve formatting and structure. It removes an extra blank line after the REUSE badge, adjusts whitespace and line wrapping across multiple Markdown sections including bullet lists and descriptive text, adds blank lines before fenced and inline content for better Markdown structure, and appends a centered HTML block containing a funding-logo image at the end of the file. 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 the project README to include (additional) Code of Conduct information and an EU funding logo.
Changes:
- Adds a new “Code of Conduct” section/link near the bottom of the README.
- Adds an EU funding logo image to 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.
This adds a second "## Code of Conduct" section, but the README already has a Code of Conduct section above (including the same link). Please remove the duplicate section or merge the new content into the existing Code of Conduct section to avoid repeated headings/links.
| ## 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.
The PR description says it "adds a link to the Code of Conduct", but that link is already present earlier in the README. If the intent is only to add the EU funding logo, please update the PR description or adjust the change so it doesn’t re-introduce an already-existing link/section.
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 EU funding logo is hot-linked from an external domain (apeirora.eu). This creates a reliability risk for the README (broken image if the host changes, and content can change outside this repo). Consider vendoring the image into the repository (or an org-controlled asset location) and referencing it via a stable path.
| <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> |
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 appears inconsistent with the referenced asset (alt mentions "BMWE" / "Bundesministerium für Wirtschaft und Energie", while the filename is "BMWK-EU.png"). Please verify the correct ministry name/acronym for the logo and align the alt text accordingly for accurate 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> |
![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)
84-84: Update width attribute to use standard HTML5 syntax.The
width="400"attribute should specify a unit for HTML5 compliance. While browsers still support the unitless format, it's deprecated.♻️ Proposed fix
-<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="https://apeirora.eu/assets/img/BMWK-EU.png" width="400px"/></p>Alternatively, use CSS for better control:
-<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="https://apeirora.eu/assets/img/BMWK-EU.png" style="width: 400px;"/></p>🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 84, The img tag using src "https://apeirora.eu/assets/img/BMWK-EU.png" currently has a unitless width="400"; update it to use a unit (e.g., width="400px") or move sizing to CSS (e.g., a style/class) to be HTML5-compliant, modifying the <img> element with alt "Bundesministerium für Wirtschaft und Klimaschutz (BMWK)-EU funding logo" accordingly.
84-84: Consider hosting the funding logo within the repository for improved reliability.The funding logo is currently hosted on an external domain (apeirora.eu), which introduces a dependency on an external resource. While the image is currently accessible, hosting it in the repository (e.g., in a
docs/images/or.github/images/folder) would provide better reliability and control—ensuring the logo remains available regardless of external site changes or availability.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 84, The README currently links the BMWK-EU funding logo from an external host via the HTML img tag (src="https://apeirora.eu/..."), which can break; download the image into the repo (e.g., docs/images/ or .github/images/), add the file to source control, and update the README.md img tag to reference the local path (e.g., docs/images/BMWK-EU.png) so the logo is served reliably from the repository.
🤖 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`:
- Line 84: The img tag using src "https://apeirora.eu/assets/img/BMWK-EU.png"
currently has a unitless width="400"; update it to use a unit (e.g.,
width="400px") or move sizing to CSS (e.g., a style/class) to be
HTML5-compliant, modifying the <img> element with alt "Bundesministerium für
Wirtschaft und Klimaschutz (BMWK)-EU funding logo" accordingly.
- Line 84: The README currently links the BMWK-EU funding logo from an external
host via the HTML img tag (src="https://apeirora.eu/..."), which can break;
download the image into the repo (e.g., docs/images/ or .github/images/), add
the file to source control, and update the README.md img tag to reference the
local path (e.g., docs/images/BMWK-EU.png) so the logo is served reliably from
the repository.
jithinkunjachan
force-pushed
the
add-coc-and-eu-funding-logo
branch
from
f90d9aa to
a9598a0
Compare
This PR adds a link to the Code of Conduct and the EU funding logo to the README.
Summary by CodeRabbit