Skip to content

Fix grammar in MAINTENANCE.md#371

Merged
adespawn merged 5 commits into
mainfrom
copilot/fix-long-commit-hash-url
Jan 5, 2026
Merged

Fix grammar in MAINTENANCE.md#371
adespawn merged 5 commits into
mainfrom
copilot/fix-long-commit-hash-url

Conversation

Copilot AI commented Jan 1, 2026

Copy link
Copy Markdown
Contributor

Corrects two grammatical errors in MAINTENANCE.md documentation.

  • Line 14: Move **NOT** to correct position: "will be NOT added" → "will NOT be added"
  • Line 36: Add missing auxiliary verb: "can potentially set up" → "can potentially be set up"

Note: The original problem statement also suggested changing the commit URL on line 25 from /pull/363/changes/SHA to /pull/363/commits/SHA. However, this change was unnecessary as the original URL format is valid and functional—it simply redirects to the destination format. Based on review feedback, the URL change has been reverted, and only the grammar fixes remain.

Original prompt
Please apply the following diffs and create a pull request.
Once the PR is ready, give it a title based on the messages of the fixes being applied.

[{"message":"The example commit link appears to be using a very long commit hash in the URL path which may not be a valid GitHub URL format. Consider using a shorter commit hash or verify the link works correctly.","fixFiles":[{"filePath":"MAINTENANCE.md","diff":"diff --git a/MAINTENANCE.md b/MAINTENANCE.md\n--- a/MAINTENANCE.md\n+++ b/MAINTENANCE.md\n@@ -22,7 +22,7 @@\n \n 1. Bump the package version. Remember to update the version in `package-lock.json` in\n main directory, examples and benchmarks\n-(see [example commit](https://github.com/scylladb/nodejs-rs-driver/pull/363/changes/41250609737052975129c7514439869324478008) on how to do that).\n+(see [example commit](https://github.com/scylladb/nodejs-rs-driver/pull/363) on how to do that).\n 2. Create a release notes on GitHub. The version tag must match version from `package.json` with `v` prefix (for example: `v0.2.0`).\n Once you publish release notes, CI action will trigger automatically. This action will build and publish the npm package.\n 3. Once the CI action finishes, check if it succeeded. If it failed, you will have to fix the underlying issue, and re-run the CI action.\n"}]},{"message":"The phrase 'will be **NOT** added' is grammatically incorrect. It should be 'will **NOT** be added' or 'will be **excluded**'.","fixFiles":[{"filePath":"MAINTENANCE.md","diff":"diff --git a/MAINTENANCE.md b/MAINTENANCE.md\n--- a/MAINTENANCE.md\n+++ b/MAINTENANCE.md\n@@ -11,7 +11,7 @@\n When you add a new top level file or directory (i.e., one put directly in the repo's root), you need to consider\n if this file / directory is necessary for the NPM package. If you determine that this file should not be present\n in the released npm package (things like rust source code, linter configuration files, ...) you have to add this\n-file to `.npmignore`. All files listed there will be **NOT** added to the npm package on release.\n+file to `.npmignore`. All files listed there will **NOT** be added to the npm package on release.\n \n #### Removing files\n \n"}]},{"message":"The phrase 'can potentially set up' is missing the word 'be'. It should read 'can potentially be set up as a CI action step'.","fixFiles":[{"filePath":"MAINTENANCE.md","diff":"diff --git a/MAINTENANCE.md b/MAINTENANCE.md\n--- a/MAINTENANCE.md\n+++ b/MAINTENANCE.md\n@@ -33,4 +33,4 @@\n `\"scylladb-driver-alpha\": \"<just-released-version>\"`,\n then run the following command:\n `npm i && node ./runner.js`\n-<!-- The last step can potentially set up as a CI action step. -->\n+<!-- The last step can potentially be set up as a CI action step. -->\n"}]}]

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: mykaul <4655593+mykaul@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix long commit hash in example commit link Fix grammar and URL formatting in MAINTENANCE.md Jan 1, 2026
Copilot AI requested a review from mykaul January 1, 2026 10:40
@mykaul mykaul marked this pull request as ready for review January 1, 2026 10:41
@wprzytula wprzytula requested a review from adespawn January 1, 2026 11:10
Comment thread MAINTENANCE.md

1. Bump the package version. Remember to update the version in `package-lock.json` in
main directory, examples and benchmarks
(see [example commit](https://github.com/scylladb/nodejs-rs-driver/pull/363/changes/41250609737052975129c7514439869324478008) on how to do that).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The goal with this link was to point a specific commit inside a PR - so this change is inadequate

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@copilot - please fix.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Fixed in commit abbd547. The URL now uses the proper GitHub format to link directly to the specific commit: https://github.com/scylladb/nodejs-rs-driver/commit/41250609737052975129c7514439869324478008

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I would still prefer the link to point to a commit inside a PR, rather than a standalone commit, unless @mykaul you have other opinion here

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@copilot please fix according to the above feedback

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Why does it want to change this link... The link after the change redirects to the original link. A little pointless, don't you agree?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@adespawn - respond to @copilot directly, not to me.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@copilot discard the change to the link

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

You're absolutely right. The original URL /pull/363/changes/SHA redirects to /pull/363/commits/SHA, so changing it is indeed pointless. I'll revert the URL change and keep only the grammar fixes.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

The URL change has already been discarded in commit 62e0848. The link remains in its original format (/pull/363/changes/SHA), and only the two grammar fixes are included in this PR.

Co-authored-by: mykaul <4655593+mykaul@users.noreply.github.com>

Copilot AI commented Jan 5, 2026

Copy link
Copy Markdown
Contributor Author

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • https://api.github.com/repos/scylladb/nodejs-rs-driver/pulls/363/commits
    • Triggering command: /usr/bin/curl curl -s REDACTED (http block)

If you need me to access, download, or install something from one of these locations, you can either:

Co-authored-by: mykaul <4655593+mykaul@users.noreply.github.com>
Co-authored-by: mykaul <4655593+mykaul@users.noreply.github.com>
Copilot AI changed the title Fix grammar and URL formatting in MAINTENANCE.md Fix grammar in MAINTENANCE.md Jan 5, 2026
Copilot AI requested a review from adespawn January 5, 2026 11:31
@adespawn adespawn merged commit 947fd86 into main Jan 5, 2026
21 checks passed
@adespawn adespawn deleted the copilot/fix-long-commit-hash-url branch January 5, 2026 12:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants