Skip to content

Add info about symbolic links to CONTRIBUTING.md.#2349

Merged
xStrom merged 3 commits intolinebender:masterfrom
xStrom:readme-link
Feb 9, 2023
Merged

Add info about symbolic links to CONTRIBUTING.md.#2349
xStrom merged 3 commits intolinebender:masterfrom
xStrom:readme-link

Conversation

@xStrom
Copy link
Member

@xStrom xStrom commented Jan 28, 2023

I figured out what was happening with v0.8.0 getting a bad README.md on crates.io. Turns out that git on Windows by default disables symbolic link support. I have now manually enabled it and tested with a test crate that publishing symlinks works as expected.

In this PR I delete the temporary copy of README.md and re-introduce the symlink. I also added a new section to CONTRIBUTING.md to help prevent this issue in the future.

@xStrom xStrom added maintenance cleans up code or docs S-needs-review waits for review labels Jan 28, 2023
Copy link
Member

@jneem jneem left a comment

Choose a reason for hiding this comment

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

Sorry, didn't realize @jaredoconnell didn't have write access...

@xStrom xStrom removed the S-needs-review waits for review label Feb 9, 2023
@xStrom xStrom merged commit e6bc9a6 into linebender:master Feb 9, 2023
@xStrom xStrom deleted the readme-link branch February 9, 2023 21:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

maintenance cleans up code or docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants