Broken symlink: drush/docs/contribute/README.md

[ruuds]

We are using drush via composer and using npm for copying the vendor directory to a 'dist' location.

After updating drush to 10.3.3 npm complains about a missing file:

Error: ENOENT: no such file or directory, stat 'vendor/drush/drush/docs/contribute/README.md'

After downloading the 10.3.3 version as an archive from Github, we found that the drush/docs/contribute/README.md file is a symbolic link to a non-existing location:

ruud@MBP-van-Ruud contribute % pwd
/Users/ruud/Downloads/drush-10.3.3/docs/contribute
ruud@MBP-van-Ruud contribute % ls -la
total 0
drwxr-xr-x@  4 ruud  staff  128 19 aug 23:08 .
drwxr-xr-x@ 25 ruud  staff  800 19 aug 23:08 ..
lrwxr-xr-x@  1 ruud  staff   21 19 aug 23:08 CONTRIBUTING.md -> ../../CONTRIBUTING.md
lrwxr-xr-x@  1 ruud  staff   21 19 aug 23:08 README.md -> ../../tests/README.md

Maybe it should symlink to ../../README.md instead of ../../tests/README.md ?

System Configuration

Q	A
Drush version?	10.3.3
Drupal version?	8.8
PHP version	7.4
OS?	Mac/Linux

[weitzman]

The intent is to symlink to tests/README.md. The symlink is working for me locally. What makes you think that the symlink is broken? Maybe your process is removing the tests dir?

[ruuds]

That was also my first thought. So I tried downloading a release archive from https://github.com/drush-ops/drush/releases/tag/10.3.3, which also contains the broken symlink.

[weitzman]

OK, I can reproduce that. The issue that the /tests dir gets stripped by https://github.com/drush-ops/drush/blob/10.x/.gitattributes. I'm inclined to move tests/README into the /docs folder. What do you think @greg-1-anderson?

[greg-1-anderson]

Yeah, let's get rid of the symlink into tests, and instead make a vestigial file tests/README that tells the user where to find the test documentation. We could alternately make tests/README.md a symlink into docs/contribute, but I think I prefer a short file. Either solution is 👍 tho