Skip to content

docs: add a contributing Git cheatsheet document #5753

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 7 commits into from
Mar 27, 2025
Merged

docs: add a contributing Git cheatsheet document #5753

merged 7 commits into from
Mar 27, 2025

Conversation

anandkaranubc
Copy link
Contributor

Resolves none.

Description

What is the purpose of this pull request?

This pull request:

  • Adds a Git cheatsheet to the contributing documentation.

Related Issues

Does this pull request have any related issues?

This pull request:

  • resolves none

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

No.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

@stdlib-js/reviewers

@anandkaranubc
docs: add a Git cheatsheet for stdlib
c2c33f0 
---
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
---
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Mar 3, 2025
@anandkaranubc anandkaranubc marked this pull request as draft March 3, 2025 07:15
@stdlib-bot stdlib-bot removed the Needs Review A pull request which needs code review. label Mar 3, 2025
@anandkaranubc
chore: fix linting issues
a91f68b 
---
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
---
@anandkaranubc anandkaranubc marked this pull request as ready for review March 3, 2025 07:26
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Mar 3, 2025
@anandkaranubc anandkaranubc added the Documentation Improvements, additions, or changes to documentation. label Mar 3, 2025
@anandkaranubc
Copy link
Contributor Author

Here’s more documentation! It’s hard to classify this as a 'cheat sheet'—it could probably be expanded into a more comprehensive document.

I haven’t included anything about resolving merge conflicts yet. Any thoughts on that?

@anandkaranubc
Copy link
Contributor Author

Is it also a good idea to add these external links (at the end)?

https://education.github.com/git-cheat-sheet-education.pdf
https://training.github.com/downloads/github-git-cheat-sheet.pdf

kgryte
kgryte reviewed Mar 18, 2025
View reviewed changes
kgryte
kgryte reviewed Mar 18, 2025
View reviewed changes
@kgryte
docs: update copy
c22efc3 
Signed-off-by: Athan <[email protected]>
kgryte
kgryte reviewed Mar 18, 2025
View reviewed changes
Copy link
Member

@kgryte kgryte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great, @anandkaranubc! Let a comment about also giving folks a hint/demo of a multi-line commit which opens their terminal editor.

@kgryte
Copy link
Member

kgryte commented Mar 18, 2025

I haven’t included anything about resolving merge conflicts yet. Any thoughts on that?

Yes, it may be good to demonstrate what a conflict looks like (e.g., <<<<<, etc). And then how to rectify.

Is it also a good idea to add these external links (at the end)?

Yes, you can include a "Other References" section at the end which contains a list of links.

Other things?

  • Could also mention the use of make commit which provides an interactive prompt to ensure adherence to project Git conventions.
  • May be worthwhile demoing an actual workflow as a series of Git commands (e.g., checkout develop, pull latest changes from upstream, push to origin, create new feature branch, add commits, rebase on top of latest develop, push new branch to origin, pull latest changes from origin (e.g., after having a reviewer commit directly to your branch), add additional commits, merge in latest develop due to having already pushed changes to remote, push changes to origin, etc).

@kgryte kgryte added Needs Changes Pull request which needs changes before being merged. and removed Needs Review A pull request which needs code review. labels Mar 19, 2025
@kgryte kgryte mentioned this pull request Mar 19, 2025
Closed
1 task
@anandkaranubc
docs: add a section for conflicts and example workflow
818e90e 
---
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
---
@anandkaranubc
docs: add other reference links
d2f4685 
---
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
---
@anandkaranubc
Copy link
Contributor Author

@kgryte I hope you enjoy the read!

@anandkaranubc anandkaranubc requested a review from kgryte March 27, 2025 01:35
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Mar 27, 2025
kgryte
kgryte reviewed Mar 27, 2025
View reviewed changes
kgryte
kgryte reviewed Mar 27, 2025
View reviewed changes
kgryte
kgryte approved these changes Mar 27, 2025
View reviewed changes
Copy link
Member

@kgryte kgryte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Any further changes can be addressed in follow-up PRs.

@kgryte kgryte removed Needs Changes Pull request which needs changes before being merged. Needs Review A pull request which needs code review. labels Mar 27, 2025
@kgryte kgryte merged commit 8a07256 into stdlib-js:develop Mar 27, 2025
10 checks passed
@anandkaranubc anandkaranubc deleted the doc/git-cheatsheet branch March 27, 2025 14:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kgryte kgryte kgryte approved these changes

Assignees

No one assigned

Labels

Documentation Improvements, additions, or changes to documentation.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@anandkaranubc @kgryte @stdlib-bot