Skip to content

Remove spelling CI in favor of GitHub Action #19973

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
TravisEz13 merged 10 commits into from
Jul 17, 2023
Merged

Remove spelling CI in favor of GitHub Action #19973

TravisEz13 merged 10 commits into from
Jul 17, 2023

Conversation

@TravisEz13
Copy link
Member

@TravisEz13 TravisEz13 commented Jul 14, 2023 •
edited
Loading

PR Summary

Remove custom spelling CI

PR Context

Nature language linter in super-linter provides more actionable results on ONLY the files changed in your PR.

PR Checklist

@TravisEz13 TravisEz13 added CL-Test Indicates that a PR should be marked as a test change in the Change Log Backport-7.2.x-Consider labels Jul 14, 2023
@TravisEz13 TravisEz13 marked this pull request as ready for review July 14, 2023 17:52
@TravisEz13 TravisEz13 changed the title Remove spelling CI Remove spelling CI in favor of GitHub Action Jul 14, 2023
daxian-dbw
daxian-dbw requested changes Jul 17, 2023
View reviewed changes
Copy link
Member

@daxian-dbw daxian-dbw left a comment

Choose a reason for hiding this comment

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

The spelling check documentation needs to be updated:
https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#spellchecking-documentation

@microsoft-github-policy-service microsoft-github-policy-service bot added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Jul 17, 2023
@microsoft-github-policy-service microsoft-github-policy-service bot removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Jul 17, 2023
@TravisEz13 TravisEz13 mentioned this pull request Jul 17, 2023
Merged
22 tasks
@StevenBucher98 StevenBucher98 added the PowerShell-Docs not needed The PR was reviewed and doesn't appear to require a PowerShell Docs update label Jul 17, 2023
daxian-dbw
daxian-dbw approved these changes Jul 17, 2023
View reviewed changes
Copy link
Member

@daxian-dbw daxian-dbw left a comment

Choose a reason for hiding this comment

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

LGTM

@TravisEz13 TravisEz13 enabled auto-merge (squash) July 17, 2023 17:39
@pull-request-quantifier-deprecated
Copy link

pull-request-quantifier-deprecated bot commented Jul 17, 2023

This PR has 150 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!

Quantification details 

Label      : Medium
Size       : +27 -123
Percentile : 50%

Total files changed: 5

Change summary by file extension:
.md : +26 -30
.yml : +1 -93

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

  • Fast and predictable releases to production:
    • Optimal size changes are more likely to be reviewed faster with fewer
      iterations.
    • Similarity in low PR complexity drives similar review times.
  • Review quality is likely higher as complexity is lower:
    • Bugs are more likely to be detected.
    • Code inconsistencies are more likely to be detected.
  • Knowledge sharing is improved within the participants:
    • Small portions can be assimilated better.
  • Better engineering practices are exercised:
    • Solving big problems by dividing them in well contained, smaller problems.
    • Exercising separation of concerns within the code changes.

What can I do to optimize my changes

  • Use the PullRequestQuantifier to quantify your PR accurately
    • Create a context profile for your repo using the context generator
    • Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
    • Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
    • Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
  • Change your engineering behaviors
    • For PRs that fall outside of the desired spectrum, review the details and check if:
      • Your PR could be split in smaller, self-contained PRs instead
      • Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

  • One line was added: +1 -0
  • One line was deleted: +0 -1
  • One line was modified: +1 -1 (git diff doesn't know about modified, it will
    interpret that line like one addition plus one deletion)
  • Change percentiles: Change characteristics (addition, deletion, modification)
    of this PR in relation to all other PRs within the repository.

Was this comment helpful? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

@TravisEz13 TravisEz13 merged commit d372832 into master Jul 17, 2023
@TravisEz13 TravisEz13 deleted the remove-spelling-ci branch July 17, 2023 18:04
@daxian-dbw daxian-dbw mentioned this pull request Jul 17, 2023
Merged
22 tasks
@daxian-dbw daxian-dbw mentioned this pull request Sep 11, 2023
Merged
daxian-dbw pushed a commit that referenced this pull request Sep 11, 2023
@TravisEz13 @daxian-dbw
Remove spelling CI in favor of GitHub Action (#19973)
afa479e 
* Remove spelling CI

* Delete mdSpell.yml

* Delete markdown.yml

* Update CONTRIBUTING.md

* repo issues

* markdown term fixes

* command-line term

* fix syntax issues

* fix codebase term

* Disable VALIDATE_EDITORCONFIG
daxian-dbw added a commit that referenced this pull request Sep 11, 2023
@daxian-dbw
[release/v7.2.14] Remove spelling CI in favor of GitHub Action (#19973)…
5ccd7c9 
… (#20239)
@daxian-dbw daxian-dbw mentioned this pull request Sep 11, 2023
Merged
daxian-dbw pushed a commit that referenced this pull request Sep 11, 2023
@TravisEz13 @daxian-dbw
Remove spelling CI in favor of GitHub Action (#19973)
b700917 
* Remove spelling CI

* Delete mdSpell.yml

* Delete markdown.yml

* Update CONTRIBUTING.md

* repo issues

* markdown term fixes

* command-line term

* fix syntax issues

* fix codebase term

* Disable VALIDATE_EDITORCONFIG
daxian-dbw added a commit that referenced this pull request Sep 11, 2023
@daxian-dbw
[release/v7.3.7] Remove spelling CI in favor of GitHub Action (#19973) (
ff7c408 
#20248)
VindSkyggen pushed a commit to VindSkyggen/PowerShell that referenced this pull request Dec 26, 2023
@TravisEz13 @VindSkyggen
Remove spelling CI in favor of GitHub Action (PowerShell#19973)
b086c2e 
* Remove spelling CI

* Delete mdSpell.yml

* Delete markdown.yml

* Update CONTRIBUTING.md

* repo issues

* markdown term fixes

* command-line term

* fix syntax issues

* fix codebase term

* Disable VALIDATE_EDITORCONFIG
@TravisEz13 TravisEz13 mentioned this pull request Apr 16, 2024
Closed
@TravisEz13 TravisEz13 mentioned this pull request Jul 9, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@daxian-dbw daxian-dbw daxian-dbw approved these changes

@adityapatwardhan adityapatwardhan Awaiting requested review from adityapatwardhan

@anmenaga anmenaga Awaiting requested review from anmenaga

Assignees

@daxian-dbw daxian-dbw

@TravisEz13 TravisEz13

@adityapatwardhan adityapatwardhan

@iSazonov iSazonov

@SeeminglyScience SeeminglyScience

Labels

Backport-7.2.x-Done Backport-7.3.x-Done CL-Test Indicates that a PR should be marked as a test change in the Change Log Medium PowerShell-Docs not needed The PR was reviewed and doesn't appear to require a PowerShell Docs update

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@TravisEz13 @daxian-dbw @adityapatwardhan @StevenBucher98 @iSazonov @SeeminglyScience