-
Notifications
You must be signed in to change notification settings - Fork 0
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
Adusted grammar in release script readme. #1
Conversation
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.
Please see comment.
scripts/release/README.md
Outdated
1. The **build** script does the heavy lifting (eg checking CI, running automated tests, building Rollup bundles) and then prints instructions for manual verification. | ||
1. The **publish** script then publishes the built artifacts to NPM and pushes to GitHub. | ||
1. The **build** script does the heavy lifting (e.g., checking CI, running automated tests, building Rollup bundles) and then prints instructions for manual verification. | ||
1. The **publish** script then publishes the built artifacts to npm and pushes to GitHub. | ||
|
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.
I agree that this current wording ("The release script runs in 2 passes") is ambiguous. I see two situations:
- If there is some sort of hidden release-script that uses build and publish, then we should clarify this.
- If there is not, then we should write down that "At a high-level, the release-process uses 2 scripts: build and publish."
I think situation 2 is a lot more likely, and thus propose the above modification.
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.
Excactly, I was thinking of the word process as well (maybe without the '-' ?). However, what if they 'like' using the word 'release script'. For instance, what about the title of the readme then?
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.
The issue is further worsened by the fact that this is all inside a folder named "scripts." At this point I'm tempted to just add a release.js-file which simply runs build and release consecutively!
I think it's relatively fine for the readme's title to remain the same, even after our proposed changes. But we could change it to "React Release Scripts" instead.
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.
That's a really good idea although I myself am just unsure whether there is some sort of hidden yarn option which might do this already.
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.
Let's just try to change it to 'Scripts' and await their response?
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.
Yes, let's.
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.
After changing Olivier's comments, I approve.
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.
Excellent.
Adjusted some grammar in the
scripts/release/README.md
file.