Skip to content

Spelling docs and comments #8619

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
Open
wants to merge 99 commits into
base: master
Choose a base branch
from
Open

Spelling docs and comments #8619

wants to merge 99 commits into from

Conversation

jsoref
Copy link

@jsoref jsoref commented May 22, 2025

Description

Checklist

  • Commit
    • Title follows commit conventions
    • Reference the relevant issue (Fixes #007, See xoa-support#42, See https://...)
    • If bug fix, add Introduced by
  • Changelog
    • If visible by XOA users, add changelog entry
    • Update "Packages to release" in CHANGELOG.unreleased.md
  • PR
    • If UI changes, add screenshots
    • If not finished or not tested, open as Draft

Review process

If you are an external contributor, you can skip this part. Simply create the pull request, and we'll get back to you as soon as possible.

This 2-passes review process aims to:

  • develop skills of junior reviewers
  • limit the workload for senior reviewers
  • limit the number of unnecessary changes by the author
  1. The author creates a PR.
  2. Review process:
    1. The author assigns the junior reviewer.
    2. The junior reviewer conducts their review:
      • Resolves their comments if they are addressed.
      • Adds comments if necessary or approves the PR.
    3. The junior reviewer assigns the senior reviewer.
    4. The senior reviewer conducts their review:
      • If there are no unresolved comments on the PR → merge.
      • Otherwise, we continue with 3.
  3. The author responds to comments and/or makes corrections, and we go back to 2.

Notes:

  1. The author can request a review at any time, even if the PR is still a Draft.
  2. In theory, there should not be more than one reviewer at a time.
  3. The author should not make any changes:
    • When a reviewer is assigned.
    • Between the junior and senior reviews.

jsoref added 30 commits May 22, 2025 08:09
@jsoref
chore(docs): Remove trailing punctuation from markdown anchors
97db419
@jsoref
link: fs
b86d5a7 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
link: VM backups
05038b8 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
link: installation
8bc5c50 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: ; otherwise,
e268cfc 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: a host
ade608c 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: a
00e7d52 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: accessible
3133595 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: across
abf6cb3 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: additional
fd6694a 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: against
d073681 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: always
5cd8228 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: ambiguous
249d3dd 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: and
e19a373 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: annotations
9e5715a 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: another
daab5d9 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: appropriate
709073e 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: are
05770ae 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: authenticated
7e75137 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: authentication
579452a 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: backing up
697fee8 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: beginning
d686b2a 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: build
e4cd1ad 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: calculation
db9f0c5 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: case-insensitive
dc786e2 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: choose
8854224 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: chronological
03d0db0 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: completely
f9720ab 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: connection
f2dd27e 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: continue
381d103 
Signed-off-by: Josh Soref <[email protected]>
jsoref added 16 commits May 22, 2025 08:09
@jsoref
spelling: self-signed
2076f31 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: should
9412c78 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: specifying
f5f5d5b 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: successful
d87a6be 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: successfully
fe01c70 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: systems
2b9c458 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: the
25b0512 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: to
9010669 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: transferred
c19f201 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: typescript
5ffb55e 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: unauthorized
1596ff1 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: unconditionally
1e853c8 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: unknown
154d2b5 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: unmaintained
884717c 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: whether
b596574 
Signed-off-by: Josh Soref <[email protected]>
@jsoref
spelling: with
a222c86 
Signed-off-by: Josh Soref <[email protected]>
@jsoref jsoref marked this pull request as ready for review May 22, 2025 12:32
@jsoref jsoref mentioned this pull request May 22, 2025
Draft
@jsoref
Copy link
Author

jsoref commented May 22, 2025 •
edited
Loading

  • For changes to .md files, I've retained their commit messages.
  • For changes to code, I effectively collapsed all changes into a single commit b3e4c56 and dropped any that appeared to be code. - This one commit will require a thorough review as the files are code. Thankfully GitHub's highlighting works pretty good to identify the actual changes in a line and it's generally pretty easy to determine that the changed portion is in a comment. - The commit message may include items not actually changed because I just selected all the commit messages that were included for the relevant files as opposed to just the ones for the content (effectively it's a squash of the relevant commits w/ the code changes dropped)

MathieuRA
MathieuRA reviewed May 27, 2025
View reviewed changes
packages/xo-lib/README.md
Comment on lines +121 to +122
xo.on('notification', function (notice) {
console.log('notification:', notice.method, notice.params)
Copy link
Member

@MathieuRA MathieuRA May 27, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

This change is not necessary, IMO we should keep the original name

pdonias
pdonias requested changes May 27, 2025
View reviewed changes
@jsoref
Fix spelling for some of these items
5d89669 
* ; otherwise,
* a
* abandoned
* accessor
* across
* additional
* address
* algorithm
* and
* apply
* assign
* availability
* beginning
* broken
* case-insensitive
* chains
* chosen
* click
* compactness
* compatibility
* completely
* configuration
* connection
* corresponding
* criteria
* dependent
* dictionary
* differentiate
* discrepancy
* duplication
* each other
* efficiently
* empty
* encrypter
* enough
* environment
* equal
* exactly
* existing
* expansion
* explicitly
* fall back
* falsish
* file
* function
* github
* id
* immutability
* implicitly
* in
* increase
* initial
* instantiated
* its
* length
* listener
* little
* localhost
* locator
* logged
* longer
* mechanisms
* metadata is also immutable
* metadata
* method
* modify
* negotiation
* nonexistent
* occurred
* ofthe
* one
* opening
* optional
* output
* overlapping
* parameters
* params
* positioning
* prepositioning
* really
* reasonable
* reinstantiated
* repair
* respect
* result
* retransferred
* save
* scanning
* self-signed
* separately
* set up
* set
* similar
* slash
* snapshot
* something
* succeed
* succeeded
* successful
* survived
* swapping
* there
* transferred
* triggering
* ubuntu
* unreasonably
* unsupported
* unwanted
* usage
* want
* will
* without
* workaround
* written

Signed-off-by: Josh Soref <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MathieuRA MathieuRA MathieuRA left review comments

@fbeauchamp fbeauchamp fbeauchamp approved these changes

@pdonias pdonias pdonias approved these changes

@OlivierFL OlivierFL OlivierFL approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@jsoref @fbeauchamp @pdonias @OlivierFL @MathieuRA