-
Notifications
You must be signed in to change notification settings - Fork 126
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
Formatted README #77
base: main
Are you sure you want to change the base?
Formatted README #77
Conversation
Please add a description and tags to the repository and disable the unsed |
Wow, no response for a year & then closed without reason, thanks. |
Hi @PhoneDroid There was some formatting additions you added that we did like. But we were not ready to accept all the changes. We closed because the PR was quite old. If you would like to open a new PR or update this one with with adding the badge links for the packages we could look at getting that merged. And please make sure to sign the CLA! We look forward to your contribution! 😄 |
@lizkenyon I reworked the content that was added since 2022. |
Co-authored-by: Liz Kenyon <[email protected]>
This mono-repo supports the following packages: | ||
# Shopify App JS | ||
|
||
*A mono-repo containing a collection of packages* |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there a particular reason why you are limiting the line length so much?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Because humans can't properly comprehend lines longer than 60~ characters
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For now I would prefer we don't use the 60 character limit, because the rest of our repositories do not follow this rule.
#### [`@shopify/shopify-app-remix`](./packages/shopify-app-remix) | ||
<br> | ||
|
||
- ### **[Remix]** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These can just be H3, remove the bullets points. And same comment for the rest of the headings.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's a stylistic choice to give a visually distinct look for the package listings, they are lists of items after all, not topics ..
WHY are these changes introduced?
Makes the README more readable / useful.
WHAT is this pull request doing?