This repository has been archived by the owner on Oct 1, 2024. It is now read-only.
[quilt] Polish repo README and package descriptions #1506
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
b-ryu
commented
Jun 11, 2020
|
|
||
| [](LICENSE.md) | ||
| [](https://travis-ci.org/Shopify/quilt) | ||
| [](https://codecov.io/gh/Shopify/quilt) | ||
| [](https://greenkeeper.io/) |
There was a problem hiding this comment.
b-ryu
force-pushed
the
1500-readme
branch
3 times, most recently
from
c8dfdca to
a353338
Compare
b-ryu
commented
Jun 11, 2020
| [](https://lernajs.io/) | ||
|
|
||
| A loosely related set of packages for JavaScript / TypeScript projects at Shopify. |
There was a problem hiding this comment.
A little nitpicky, but if we change this here we'll also probably want to change it in the repo description on the GitHub page
b-ryu
commented
Jun 12, 2020
|
|
||
| function validatePackageName(name) { | ||
| return ( | ||
| /^(?:@[a-z0-9-*~][a-z0-9-*._~]*\/)?[a-z0-9-~][a-z0-9-._~]*$/g.test( |
There was a problem hiding this comment.
This regex was copied directly from a lint warning in VS Code:
b-ryu
force-pushed
the
1500-readme
branch
3 times, most recently
from
503a2dc to
c77d0d8
Compare
ismail-syed
approved these changes
Jun 22, 2020
This was referenced Aug 1, 2022
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Fixes #1500
This PR does some minor polish on package descriptions and the repo-level
README.md.README.md(add descriptions, etc.)'vs.')README.mdsquilt_railsregarding newNetworkUniversalProviderTophat
You can test the changes made to the plop template/generators using the following steps:
dev cd quilt && git fetch --all && git checkout 1500-readmeyarn generate docsto generate a new repoREADME.mdwith package names and descriptions pulled from individualpackage.jsonsyarn generate packageto create a test packageREADME.mdshould preserve description formatting