Packaging of README.md as a link creates warnings spam in Unity
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 88/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- git, unity
- Domain
- build-system
Research direction
Inspect the UPM package com.valvesoftware.openxr.utils and its README.md entry, then review the Git-based installation described in Documentation~/index.md. Replace the symlink with a regular README.md file and verify that a cloned Git dependency no longer produces the reported Unity metadata warnings.
Written by the indexing model from the issue text.
Description
The UPM package structure for com.valvesoftware.openxr.utils includes a README.md file which is a symlink instead of a regular file. Normal git cloning will not resolve that link so README.md will be absent in a clone. Consequently, if a Unity project includes this package as a Git dependency (which is exactly what this package's documentation tells users to do), every time the project is compiled, these warnings will be spammed to the console:
A meta data file (.meta) exists but its asset 'Packages/com.valvesoftware.openxr.utils/README.md' can't be found. When moving or deleting files outside of Unity, please ensure that the corresponding .meta file is moved or deleted along with it.
and
Couldn't delete Packages/com.valvesoftware.openxr.utils/README.md.meta because it's in an immutable folder.
(not to mention the wasted work the Unity editor is doing trying in vain to delete this meta file.)
Can this just be changed to a regular file?
- Dominant language
- C#
- Stars
- 65
- Forks
- 2
- Avg merge
- 1m
- Merged PRs (30d)
- 3
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from ValveSoftware/Unity
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
ValveSoftware/Unity#12 ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
ValveSoftware/Unity#15 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
ValveSoftware/Unity#14 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
ValveSoftware/Unity#11 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
ValveSoftware/Unity#9 · 2 comments ·
All issues in ValveSoftware/Unity
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
AvaloniaUI/Avalonia#22323 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
microsoft/onnxruntime-genai#2633 ·
Maintainers usually reply within 1 day
-
Not reproducible
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
microsoft/fluentui-blazor#5350 · 4 comments ·
Maintainers usually reply within 1 day
-
python triage
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
microsoft/semantic-kernel#14491 ·
Maintainers usually reply within 2 days
-
area:jobads-cv FE mvp P3
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
klasolsson81/jobbliggaren#1878 ·
Maintainers usually reply within 1 day