Skip to content

Commit a91f68b

Browse files
committed
chore: fix linting issues
--- 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 --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na ---
1 parent c2c33f0 commit a91f68b

File tree

1 file changed

+22
-16
lines changed

1 file changed

+22
-16
lines changed

docs/contributing/git_cheatsheet.md

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -139,9 +139,9 @@ Once pushed, your changes will be available on GitHub, and you can proceed to cr
139139

140140
A pull request (PR) is a way to suggest changes to a project. It lets maintainers review your work, give feedback, and approve the changes before adding them to the main repository. This is how you officially submit your contributions to `stdlib` after pushing your changes:
141141

142-
1. Go to your fork on GitHub.
143-
2. Click "Compare & pull request."
144-
3. Add a clear title and description (mention what you changed and why).
142+
1. Go to your fork on GitHub.
143+
2. Click "Compare & pull request."
144+
3. Add a clear title and description (mention what you changed and why).
145145

146146
Once you create your pull request, a review request will be **automatically** sent to the maintainers via `stdlib-bot`. Your code will then be reviewed, and you may need to make some tweaks before it gets merged.
147147

@@ -188,7 +188,7 @@ While working on a feature branch, new changes might be added to the `develop` b
188188

189189
Rebasing **moves** your commits on top of the latest `develop`, as if you had started working after the newest updates.
190190

191-
#### Steps to Rebase:
191+
#### Steps to Rebase
192192

193193
<!-- run-disable -->
194194

@@ -209,13 +209,16 @@ git rebase --continue
209209
#### Example: How Rebase Works
210210

211211
Before rebasing (`develop` has new commits `C` and `D`):
212-
```
212+
213+
```plaintext
213214
X---Y---Z (feature/my-branch)
214215
/
215216
A---B---C---D (develop)
216217
```
218+
217219
After rebasing (`X, Y, Z` are reapplied on top of `D`):
218-
```
220+
221+
```plaintext
219222
X'--Y'--Z' (feature/my-branch, rebased)
220223
/
221224
A---B---C---D (develop)
@@ -225,7 +228,7 @@ A---B---C---D (develop)
225228

226229
Merging **combines** your feature branch with `develop`, keeping both histories intact and adding a new merge commit.
227230

228-
#### Steps to Merge:
231+
#### Steps to Merge
229232

230233
<!-- run-disable -->
231234

@@ -247,27 +250,32 @@ git push origin feature/my-branch
247250
#### Example: How Merge Works
248251

249252
Before merging (`develop` has new commits `C` and `D`):
250-
```
253+
254+
```plaintext
251255
X---Y---Z (feature/my-branch)
252256
/
253257
A---B---C---D (develop)
254258
```
259+
255260
After merging (`W` is a new merge commit):
256-
```
261+
262+
```plaintext
257263
X---Y---Z---W (feature/my-branch, merged)
258264
/ /
259265
A---B---C-------D (develop)
260266
```
261267

262-
### Which one should you use?
268+
### Choosing the Right One
263269

264270
Use **Rebase** if:
265-
- You want a clean, linear history.
266-
- You are working alone or sure that no one else depends on your commits.
271+
272+
- You want a clean, linear history.
273+
- You are working alone or sure that no one else depends on your commits.
267274

268275
Use **Merge** if:
269-
- You want a safer approach that doesn’t rewrite history.
270-
- You are unsure about rebase or are collaborating on the branch.
276+
277+
- You want a safer approach that doesn’t rewrite history.
278+
- You are unsure about rebase or are collaborating on the branch.
271279

272280
> **When in doubt, use merge.** It is safer and avoids potential conflicts caused by rewriting history. If you use the GitHub UI to update your branches, it also performs a merge.
273281
@@ -289,8 +297,6 @@ To get started with your first contribution, check out the [Contributing Guide][
289297

290298
[github-remote]: https://help.github.com/articles/configuring-a-remote-for-a-fork/
291299

292-
[git-clone-depth]: https://git-scm.com/docs/git-clone#git-clone---depthltdepthgt
293-
294300
[git-remotes]: https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes
295301

296302
[github-fork]: https://help.github.com/articles/fork-a-repo/

0 commit comments

Comments
 (0)