Skip to content

docs: add FAQ for unrelated PR changes #6415

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
kgryte merged 7 commits into from
Mar 29, 2025
Merged

docs: add FAQ for unrelated PR changes #6415

kgryte merged 7 commits into from
Mar 29, 2025

Conversation

@anandkaranubc
Copy link
Contributor

@anandkaranubc anandkaranubc commented Mar 27, 2025

Resolves none.

Description

What is the purpose of this pull request?

This pull request:

  • Adds a FAQ for resolving unrelated file changes in PRs

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 faq for handling unrelated commits
1ccf7c5 
---
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
---
@anandkaranubc
Merge branch 'develop' into docs/git-errors
aae2a5c
@anandkaranubc
chore: minor wording fix
b4ddb0e 
---
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
---
@anandkaranubc
docs: add link to git cheatsheet
a1ae9e0 
---
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
---
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Mar 27, 2025
@anandkaranubc
Copy link
Contributor Author

anandkaranubc commented Mar 27, 2025

I think it's a good moment to use the Git cheatsheet and add this FAQ. 😄

@kgryte kgryte added the Documentation Improvements, additions, or changes to documentation. label Mar 27, 2025
kgryte
kgryte previously 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. My only comment is that I am fairly anti-force-push, as it can really mess with other devs local copies of a contributor's work. My stance is that, as soon as you start collaborating, force pushes should not be used. Before a PR is made, sure, as in that case, you are only force pushing to your remote repo. But once that PR is made, best to use merge. This may not be best practice in other projects outside of stdlib where a stack of commits is merged, as is. With stdlib, because we almost exclusively squash and merge, we don't have stringent PR Git history requirements, so long as the diff contains only relevant changes. Meaning, having merge commits in a PR's commit history is fine, so long as the diff is clean.

@kgryte kgryte removed the Needs Review A pull request which needs code review. label Mar 27, 2025
@anandkaranubc anandkaranubc marked this pull request as draft March 27, 2025 20:54
@anandkaranubc
Copy link
Contributor Author

anandkaranubc commented Mar 27, 2025

@kgryte That makes sense. Thanks for explaining that.

I will update the FAQ accordingly.

@anandkaranubc
chore: apply suggestions from review
903fd69 
---
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
---
@anandkaranubc anandkaranubc marked this pull request as ready for review March 27, 2025 21:19
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Mar 27, 2025
@anandkaranubc
Copy link
Contributor Author

anandkaranubc commented Mar 27, 2025 •
edited
Loading

That said, this becomes a fairly tricky question to answer, requiring a careful balance to avoid over-including or under-including. If the changes look good, I'll also update the Git Cheat Sheet to explicitly include this point (in a separate PR).

kgryte
kgryte reviewed Mar 28, 2025
View reviewed changes
kgryte
kgryte reviewed Mar 28, 2025
View reviewed changes
@anandkaranubc
chore: apply suggestions from review
d6d9307 
---
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
---
kgryte
kgryte reviewed Mar 29, 2025
View reviewed changes
kgryte
kgryte approved these changes Mar 29, 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

@kgryte kgryte removed the Needs Review A pull request which needs code review. label Mar 29, 2025
@kgryte kgryte merged commit 71fc239 into stdlib-js:develop Mar 29, 2025
9 checks passed
@anandkaranubc anandkaranubc deleted the docs/git-errors branch May 10, 2025 14:34
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