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.

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 #2999

Merged
merged 4 commits into from
May 20, 2020
Merged

Update README.md #2999

merged 4 commits into from
May 20, 2020

Conversation

MadeByMike
Copy link
Contributor

Update with notes on version control/dependency management.

@changeset-bot
Copy link

changeset-bot bot commented May 20, 2020

💥 No Changeset

Latest commit: a8bb904

Merging this PR will not cause any packages to be released. If these changes should not cause updates to packages in this repo, this is fine 🙂

If these changes should be published to npm, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

@thekevinbrown thekevinbrown left a comment

Choose a reason for hiding this comment

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

Might be nice to add a note about, "We're trying to improve our tooling to make this less likely in the future, you can follow progress on #...." but either way this is an improvement for sure. Can understand not wanting to link to an issue in the readme.

Also, handy to see the changelog browser, wasn't aware I could do that and it's also very helpful for me.

@MadeByMike
Copy link
Contributor Author

I kinda don't want to link to an issue on the front page of the repo. Not that I have any issue surfacing it but we're walking a line here between an easy introduction for new users and details for technical users. I'll see if there is another relevant (but slightly less prominent) place I can link to the issue. - Make sure it's at least easily discoverable for people searching for it

README.md Outdated Show resolved Hide resolved
@MadeByMike MadeByMike merged commit 7f1ea85 into master May 20, 2020
@MadeByMike MadeByMike deleted the update-readme branch May 20, 2020 06:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants