Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #283

Merged
merged 7 commits into from
Jan 30, 2025
Merged

Update README.md #283

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4e23078
Update README.md
mrwellmann Jan 23, 2025
84a534d
Fixed Open UPM Link
mrwellmann Jan 23, 2025
e11ba73
Fixed html formatting issue
mrwellmann Jan 23, 2025
640cd3f
Merge branch 'develop' into feature/MP-3178-Implemente-PR-Agents
mrwellmann Jan 23, 2025
cb69eec
Removed Github Action pr_agent
mrwellmann Jan 23, 2025
5e2efdf
Fixed outdated links at below
poetter-sebastian Jan 28, 2025
fd086ab
Added some more link descriptions
poetter-sebastian Jan 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 0 additions & 26 deletions .github/workflows/pr_agent.yml
View file
Open in desktop

This file was deleted.

18 changes: 6 additions & 12 deletions README.md
View file
Open in desktop
Copy link

Choose a reason for hiding this comment

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

Changes walkthrough 📝

Documentation
README.md (+6/-12)
Enhanced badge links and formatting in README                       

README.md

  • Updated OpenUPM badge link and formatting.
  • Added a CodeFactor badge for repository quality.
  • Fixed HTML structure and formatting for badges.
  • Removed unnecessary whitespace in badge section.

    • Original file line number Diff line number Diff line change
    Expand Up @@ -23,20 +23,14 @@
    </p>

    <p align="center">
    <a href="https://openupm.com/packages/co.mindport.vrbuilder.core/" target="_blank">
    <img alt="Static Badge" src="https://img.shields.io/badge/OpenUPM-v5.0.0-Blue?logo=UPM&color=%2378f1c8">
    </a>
    <a href="https://github.com/MindPort-GmbH/VR-Builder/releases" target="_blank">
    <img alt="Static Badge" src="https://img.shields.io/github/downloads/MindPort-GmbH/VR-Builder/total.svg">
    </a>
    <a href="https://github.com/MindPort-GmbH/VR-Builder/issues?q=is%3Aopen" target="_blank">
    <img alt="Static Badge" src="https://img.shields.io/github/issues/MindPort-GmbH/VR-Builder?style=flat-square&color=%232EA043&label=open issues">
    </a>
    <a href="https://discord.com/invite/aUdwRRPgrK" target="_blank">
    <img src="https://img.shields.io/discord/861482616539578378" alt="Discord conversation">
    </a>
    <a href="https://openupm.com/packages/co.mindport.vrbuilder.core/"><img src="https://img.shields.io/npm/v/co.mindport.vrbuilder.core?label=openupm&amp;registry_uri=https://package.openupm.com" /></a>
    <a href="https://github.com/MindPort-GmbH/VR-Builder/releases" target="_blank"><img alt="Static Badge" src="https://img.shields.io/github/downloads/MindPort-GmbH/VR-Builder/total.svg"></a>
    <a href="https://github.com/MindPort-GmbH/VR-Builder/issues?q=is%3Aopen" target="_blank"><img src="https://img.shields.io/github/issues/MindPort-GmbH/VR-Builder?style=flat-square&color=%232EA043&label=open issues"></a>
    <a href="https://www.codefactor.io/repository/github/mindport-gmbh/vr-builder"><img alt="CodeFactor" src="https://www.codefactor.io/repository/github/mindport-gmbh/vr-builder/badge"></a>
    <a href="https://discord.com/invite/aUdwRRPgrK" target="_blank"><img alt="Discord conversation" src="https://img.shields.io/discord/861482616539578378"></a>
    Copy link

    Choose a reason for hiding this comment

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

    🛠️ Refactor suggestion

    Add alt text to badge images for accessibility.

    Some badge images are missing alt text, which impacts accessibility. Additionally, there are inconsistencies in badge styling and link attributes.

    Apply these changes to improve accessibility and consistency:

    -    <a href="https://openupm.com/packages/co.mindport.vrbuilder.core/"><img src="https://img.shields.io/npm/v/co.mindport.vrbuilder.core?label=openupm&amp;registry_uri=https://package.openupm.com" /></a>
-    <a href="https://github.com/MindPort-GmbH/VR-Builder/releases" target="_blank"><img alt="Static Badge" src="https://img.shields.io/github/downloads/MindPort-GmbH/VR-Builder/total.svg"></a>
-    <a href="https://github.com/MindPort-GmbH/VR-Builder/issues?q=is%3Aopen" target="_blank"><img src="https://img.shields.io/github/issues/MindPort-GmbH/VR-Builder?style=flat-square&color=%232EA043&label=open issues"></a>
-    <a href="https://www.codefactor.io/repository/github/mindport-gmbh/vr-builder"><img alt="CodeFactor" src="https://www.codefactor.io/repository/github/mindport-gmbh/vr-builder/badge"></a>
-    <a href="https://discord.com/invite/aUdwRRPgrK" target="_blank"><img alt="Discord conversation" src="https://img.shields.io/discord/861482616539578378"></a>
+    <a href="https://openupm.com/packages/co.mindport.vrbuilder.core/" target="_blank"><img alt="OpenUPM Version" src="https://img.shields.io/npm/v/co.mindport.vrbuilder.core?label=openupm&amp;registry_uri=https://package.openupm.com&style=flat-square" /></a>
+    <a href="https://github.com/MindPort-GmbH/VR-Builder/releases" target="_blank"><img alt="GitHub Downloads" src="https://img.shields.io/github/downloads/MindPort-GmbH/VR-Builder/total.svg?style=flat-square"></a>
+    <a href="https://github.com/MindPort-GmbH/VR-Builder/issues?q=is%3Aopen" target="_blank"><img alt="GitHub Open Issues" src="https://img.shields.io/github/issues/MindPort-GmbH/VR-Builder?style=flat-square&color=%232EA043&label=open issues"></a>
+    <a href="https://www.codefactor.io/repository/github/mindport-gmbh/vr-builder" target="_blank"><img alt="CodeFactor Grade" src="https://www.codefactor.io/repository/github/mindport-gmbh/vr-builder/badge?style=flat-square"></a>
+    <a href="https://discord.com/invite/aUdwRRPgrK" target="_blank"><img alt="Discord Members" src="https://img.shields.io/discord/861482616539578378?style=flat-square"></a>
    📝 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.

    Suggested change
    <a href="https://openupm.com/packages/co.mindport.vrbuilder.core/"><img src="https://img.shields.io/npm/v/co.mindport.vrbuilder.core?label=openupm&amp;registry_uri=https://package.openupm.com" /></a>
    <a href="https://github.com/MindPort-GmbH/VR-Builder/releases" target="_blank"><img alt="Static Badge" src="https://img.shields.io/github/downloads/MindPort-GmbH/VR-Builder/total.svg"></a>
    <a href="https://github.com/MindPort-GmbH/VR-Builder/issues?q=is%3Aopen" target="_blank"><img src="https://img.shields.io/github/issues/MindPort-GmbH/VR-Builder?style=flat-square&color=%232EA043&label=open issues"></a>
    <a href="https://www.codefactor.io/repository/github/mindport-gmbh/vr-builder"><img alt="CodeFactor" src="https://www.codefactor.io/repository/github/mindport-gmbh/vr-builder/badge"></a>
    <a href="https://discord.com/invite/aUdwRRPgrK" target="_blank"><img alt="Discord conversation" src="https://img.shields.io/discord/861482616539578378"></a>
    <a href="https://openupm.com/packages/co.mindport.vrbuilder.core/" target="_blank"><img alt="OpenUPM Version" src="https://img.shields.io/npm/v/co.mindport.vrbuilder.core?label=openupm&amp;registry_uri=https://package.openupm.com&style=flat-square" /></a>
    <a href="https://github.com/MindPort-GmbH/VR-Builder/releases" target="_blank"><img alt="GitHub Downloads" src="https://img.shields.io/github/downloads/MindPort-GmbH/VR-Builder/total.svg?style=flat-square"></a>
    <a href="https://github.com/MindPort-GmbH/VR-Builder/issues?q=is%3Aopen" target="_blank"><img alt="GitHub Open Issues" src="https://img.shields.io/github/issues/MindPort-GmbH/VR-Builder?style=flat-square&color=%232EA043&label=open issues"></a>
    <a href="https://www.codefactor.io/repository/github/mindport-gmbh/vr-builder" target="_blank"><img alt="CodeFactor Grade" src="https://www.codefactor.io/repository/github/mindport-gmbh/vr-builder/badge?style=flat-square"></a>
    <a href="https://discord.com/invite/aUdwRRPgrK" target="_blank"><img alt="Discord Members" src="https://img.shields.io/discord/861482616539578378?style=flat-square"></a>
    🧰 Tools
    🪛 Markdownlint (0.37.0)

    26-26: null
    Images should have alternate text (alt text)

    (MD045, no-alt-text)

    28-28: null
    Images should have alternate text (alt text)

    (MD045, no-alt-text)

    </p>


    ## Introduction

    <video src="https://github.com/MindPort-GmbH/VR-Builder/assets/247111/ca755abb-23fa-4742-a66c-2785bff4e80f" width="300"></video>
    Expand Down