Skip to content

Commit 903fd69

Browse files
committed
chore: apply suggestions from review
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent a1ae9e0 commit 903fd69

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/contributing/FAQ.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -297,22 +297,22 @@ To see other available bot commands, comment `/stdlib help` on your PR.
297297

298298
When you open a pull request or push changes to your feature branch, GitHub compares your feature branch against your `develop` branch and shows all the differences. If your feature branch contains outdated or extra changes, they will appear in the PR, even if they are unrelated to your work.
299299

300-
To fix this, ensure that your feature branch is based on your latest `develop` branch. You can do this by rebasing/merging your feature branch with the `develop` branch:
300+
To fix this, ensure that your feature branch is based on your latest `develop` branch. You can do this by merging your `develop` branch into your feature branch:
301301

302302
```bash
303303
$ git checkout develop
304304
$ git pull origin develop
305305
$ git checkout feature-branch
306-
$ git rebase develop # or git merge develop
306+
$ git merge develop
307307
```
308308

309-
After rebasing/merging, force-push your changes to the remote feature branch:
309+
After merging, push your changes to the remote repository:
310310

311311
```bash
312-
$ git push origin feature-branch --force
312+
$ git push origin feature-branch # git push also works
313313
```
314314

315-
> If you want to learn more about rebasing/merging, you can refer to our [Git guide][git-guide].
315+
> **Note**: At stdlib, we recommend using `merge` instead of `rebase` once a PR is open. Rebasing rewrites your branch history, which usually requires a force-push to update the remote branch. This can disrupt other contributors who are reviewing or collaborating on your PR. Since stdlib uses squash and merge for PRs, we don’t require a clean, linear commit history. Merge commits are totally fine as long as your diff only contains relevant changes. If you want to learn more about rebasing/merging, you can refer to our [Git guide][git-guide].
316316
317317
Alternatively, you can call the **stdlib-bot** to merge changes from the `develop` branch into your PR. To do this, comment `/stdlib merge` on your PR.
318318

0 commit comments

Comments
 (0)