docs: Add Code of Conduct link and EU funding logo to README#60
docs: Add Code of Conduct link and EU funding logo to README#60jithinkunjachan 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 README.md file has been updated with formatting improvements throughout the document. Additional line breaks have been inserted around various sections including SAPUI5 documentation links, IDE and environment instructions, deployment guidelines, and security/contributing content. The deployment steps have been renumbered, with "Deploy from the 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’s README.md to add a Code of Conduct link and display 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 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). | ||
|
|
||
| <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 now has a second “## Code of Conduct” section (there is already one at lines ~152–155). This duplicates content and can confuse readers; please remove this new section and, if needed, add the EU funding logo under a separate, appropriately named section (e.g., “Funding/Acknowledgements”) or extend the existing Code of Conduct section instead.
| ## 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 / Acknowledgements | |
| <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> |
|
|
||
| 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 hotlinked from an external domain (apeirora.eu). Rendering the README will trigger third‑party requests (privacy/tracking risk) and the image could break if the remote asset moves. Consider committing the logo into the repo (or using a GitHub-hosted asset) and referencing it locally.
| <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="assets/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.
Alt text says “Bundesministerium für Wirtschaft und Energie (BMWE)” but the image filename/branding in the URL is “BMWK-EU.png”. Please verify the correct ministry name/acronym and make the alt text consistent with the referenced logo (and ideally the official wording).
| <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.
Actionable comments posted: 2
🧹 Nitpick comments (1)
README.md (1)
186-186: Prefer repository-hosted logo asset over external hotlink.Line 186 references an external domain for a core README asset. Consider storing the logo in-repo (e.g.,
docs/assets/...) and linking it relatively to avoid external availability/privacy dependency.♻️ Suggested doc 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="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 186, README currently hotlinks the BMWK-EU logo via the external src URL in the <img> tag; instead, download the logo into the repo (e.g., docs/assets/BMWK-EU.png) and update the <img> tag's src to the relative path (e.g., docs/assets/BMWK-EU.png) so the README references the repository-hosted asset; ensure the new file is added to version control and the image width/alt attributes remain unchanged.
🤖 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 47: Update the OS branding in the README text: change the instance of
"MacOS" in the sentence that starts "If using a local CMK API instance and are
using MacOS, run `npm run startchrome` ..." to the correct lowercase "macOS" so
the documentation uses the proper OS name.
- Line 45: Replace the phrase "3rd party webserver" in the README line "Using a
3rd party webserver is NOT supported due to using UI5 middleware." with the
corrected wording "third-party web server" so the sentence reads: "Using a
third-party web server is NOT supported due to using UI5 middleware." Ensure
spacing/hyphenation matches this exact phrasing.
---
Nitpick comments:
In `@README.md`:
- Line 186: README currently hotlinks the BMWK-EU logo via the external src URL
in the <img> tag; instead, download the logo into the repo (e.g.,
docs/assets/BMWK-EU.png) and update the <img> tag's src to the relative path
(e.g., docs/assets/BMWK-EU.png) so the README references the repository-hosted
asset; ensure the new file is added to version control and the image width/alt
attributes remain unchanged.
| npm install | ||
| ``` | ||
|
|
||
| 4. To start the local development server, run `npm start`. Using a 3rd party webserver is NOT supported due to using UI5 middleware. If using the mock server, remember to start that separately [as shown here](https://github.com/openkcm/cmk-ui/blob/main/README.md#local-api): |
There was a problem hiding this comment.
Tighten wording in setup docs on Line 45.
“3rd party webserver” should be “third-party web server” for correct style and readability.
✏️ Suggested doc fix
-4. To start the local development server, run `npm start`. Using a 3rd party webserver is NOT supported due to using UI5 middleware. If using the mock server, remember to start that separately [as shown here](https://github.com/openkcm/cmk-ui/blob/main/README.md#local-api):
+4. To start the local development server, run `npm start`. Using a third-party web server is NOT supported due to using UI5 middleware. If using the mock server, remember to start that separately [as shown here](https://github.com/openkcm/cmk-ui/blob/main/README.md#local-api):📝 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.
| 4. To start the local development server, run `npm start`. Using a 3rd party webserver is NOT supported due to using UI5 middleware. If using the mock server, remember to start that separately [as shown here](https://github.com/openkcm/cmk-ui/blob/main/README.md#local-api): | |
| 4. To start the local development server, run `npm start`. Using a third-party web server is NOT supported due to using UI5 middleware. If using the mock server, remember to start that separately [as shown here](https://github.com/openkcm/cmk-ui/blob/main/README.md#local-api): |
🧰 Tools
🪛 LanguageTool
[grammar] ~45-~45: Use a hyphen to join words.
Context: ...ent server, run npm start. Using a 3rd party webserver is NOT supported due to ...
(QB_NEW_EN_HYPHEN)
[grammar] ~45-~45: Ensure spelling is correct
Context: ...ver, run npm start. Using a 3rd party webserver is NOT supported due to using UI5 middl...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` at line 45, Replace the phrase "3rd party webserver" in the README
line "Using a 3rd party webserver is NOT supported due to using UI5 middleware."
with the corrected wording "third-party web server" so the sentence reads:
"Using a third-party web server is NOT supported due to using UI5 middleware."
Ensure spacing/hyphenation matches this exact phrasing.
|
|
||
| 4. To start the local development server, run `npm start`. Using a 3rd party webserver is NOT supported due to using UI5 middleware. If using the mock server, remember to start that separately [as shown here](https://github.com/openkcm/cmk-ui/blob/main/README.md#local-api): | ||
| 5. Application will start on port 8081 | ||
| 6. If using a local CMK API instance and are using MacOS, run `npm run startchrome` to open a Chrome instance with web security turned off. Using a normal Chrome browser will result in CORS errors. |
There was a problem hiding this comment.
Use correct OS branding on Line 47.
“MacOS” should be “macOS”.
✏️ Suggested doc fix
-6. If using a local CMK API instance and are using MacOS, run `npm run startchrome` to open a Chrome instance with web security turned off. Using a normal Chrome browser will result in CORS errors.
+6. If using a local CMK API instance and are using macOS, run `npm run startchrome` to open a Chrome instance with web security turned off. Using a normal Chrome browser will result in CORS errors.📝 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.
| 6. If using a local CMK API instance and are using MacOS, run `npm run startchrome` to open a Chrome instance with web security turned off. Using a normal Chrome browser will result in CORS errors. | |
| 6. If using a local CMK API instance and are using macOS, run `npm run startchrome` to open a Chrome instance with web security turned off. Using a normal Chrome browser will result in CORS errors. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~47-~47: The operating system from Apple is written “macOS”.
Context: ... a local CMK API instance and are using MacOS, run npm run startchrome to open a Ch...
(MAC_OS)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` at line 47, Update the OS branding in the README text: change the
instance of "MacOS" in the sentence that starts "If using a local CMK API
instance and are using MacOS, run `npm run startchrome` ..." to the correct
lowercase "macOS" so the documentation uses the proper OS name.
jithinkunjachan
force-pushed
the
add-coc-and-eu-funding-logo
branch
from
75eb9dd to
5f1db02
Compare
This PR adds a link to the Code of Conduct and the EU funding logo to the README.
Summary by CodeRabbit