diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index eb52da8d6f..7eac25c493 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,8 +13,6 @@ Contributions are what makes the open source community such an amazing place to - Issues from non-core members automatically receive the `🚨 needs approval` label. - We greatly value new feature ideas. To ensure consistency in the product's direction, they undergo review and approval. - - ## Priorities @@ -178,11 +176,15 @@ If you get errors, be sure to fix them before committing. Do not commit your `yarn.lock` unless you've made changes to the `package.json`. If you've already committed `yarn.lock` unintentionally, follow these steps to undo: If your last commit has the `yarn.lock` file alongside other files and you only wish to uncommit the `yarn.lock`: + ```bash git checkout HEAD~1 yarn.lock git commit -m "Revert yarn.lock changes" ``` + +_NB_: You may have to bypass the pre-commit hook with by appending `--no-verify` to the git commit If you've pushed the commit with the `yarn.lock`: + 1. Correct the commit locally using the above method. 2. Carefully force push: @@ -194,26 +196,35 @@ If `yarn.lock` was committed a while ago and there have been several commits sin 1. **Checkout a Previous Version**: - Find the commit hash before the `yarn.lock` was unintentionally committed. You can do this by viewing the Git log: + ```bash git log yarn.lock ``` + - Once you have identified the commit hash, use it to checkout the previous version of `yarn.lock`: + ```bash git checkout yarn.lock ``` 2. **Commit the Reverted Version**: - After checking out the previous version of the `yarn.lock`, commit this change: + ```bash git commit -m "Revert yarn.lock to its state before unintended changes" ``` 3. **Proceed with Caution**: - If you need to push this change, first pull the latest changes from your remote branch to ensure you're not overwriting other recent changes: + ```bash git pull origin ``` + - Then push the updated branch: + ```bash git push origin ``` + +Lastly, make sure to keep the branches updated (e.g. click the `Update branch` button on GitHub PR).