-
Notifications
You must be signed in to change notification settings - Fork 64
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
Updating CONTRIBUTING.md #775
Conversation
…github bot that does that
✔️ Deploy Preview for storeui ready! 🔨 Explore the source changes: 613fac6 🔍 Inspect the deploy log: https://app.netlify.com/sites/storeui/deploys/60ca5f750a6a26000700e487 😎 Browse the preview: https://deploy-preview-775--storeui.netlify.app |
CONTRIBUTING.MD
Outdated
@@ -52,30 +52,27 @@ Example: | |||
|
|||
1. After acquiring the necessary approval, rebase and squash-merge your PR in master | |||
|
|||
2. Locally, go to the master branch pull the changes with `git pull origin master` | |||
2. A bot will commit on master releasing your changes. In the mean time, go grab a coffe ☕ |
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.
Typo: meantime
and coffee
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.
Oops
CONTRIBUTING.MD
Outdated
4. Go grab a coffe ☕ | ||
> If the bot isn't working or you want to release it manually, use the following command to clean any artifact and release a clean build: | ||
> | ||
> `git clean -fdx && yarn && lerna run build && lerna publish minor --yes` |
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 it ok to release minor version here?
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.
patch!!
CONTRIBUTING.MD
Outdated
``` | ||
git rebase origin/master && git push --force | ||
``` | ||
|
||
8. Wait for the bots to approve the PR. | ||
6. Wait for the bots to approve the PR. |
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 would rewrite it to something like that,
6. Wait for the bots to approve the PR. | |
6. Wait for the PR checks to have been passed |
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 613fac6:
|
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.
lgtm!! Good to see you updating the docs, thank you 😄
afa6818
to
613fac6
Compare
* Removing release commands from contributing due to the addition of a github bot that does that * Improving grammar and changing release command to patch on the contributors guide
What's the purpose of this pull request?
This PR updates the CONTRIBUTING.md guide to not include the commands to release the application, since we have a bot that does that for us now.
I was following this guide and almost re-released the version I merged, so I think it would be good for contributors to have a disclaimer about the bot. Also, I think the command may still be useful, so I left it there with a disclaimer.