Skip to content

Switch to GitHub Action for linting markdown - #19899

Merged
Travis Plunk (TravisEz13) merged 8 commits into
masterfrom
Remove-direct-use-of-markdownlint
Jul 7, 2023
Merged

Switch to GitHub Action for linting markdown#19899
Travis Plunk (TravisEz13) merged 8 commits into
masterfrom
Remove-direct-use-of-markdownlint

Conversation

@TravisEz13

@TravisEz13 Travis Plunk (TravisEz13) commented Jul 6, 2023

Copy link
Copy Markdown
Member

PR Summary

Switch to GitHub Action for linting markdown

PR Context

It's just easier if the tools aren't directly in our repo.

PR Checklist

Comment thread tools/clearlyDefined/readme.md Outdated
@TravisEz13 Travis Plunk (TravisEz13) changed the title Update markdownLink.yml Switch to GitHub Action for linting markdown Jul 6, 2023
@TravisEz13
Travis Plunk (TravisEz13) marked this pull request as ready for review July 6, 2023 23:32

@SteveL-MSFT Steve Lee (SteveL-MSFT) left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

Comment thread .github/workflows/markdownLink.yml Outdated

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

just a typo to correct

Co-authored-by: James Truher [MSFT] <jimtru@microsoft.com>
@TravisEz13
Travis Plunk (TravisEz13) merged commit aa31732 into master Jul 7, 2023
@TravisEz13
Travis Plunk (TravisEz13) deleted the Remove-direct-use-of-markdownlint branch July 7, 2023 17:15
@pull-request-quantifier-deprecated

Copy link
Copy Markdown

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


Quantification details

Label      : Large
Size       : +16 -224
Percentile : 64%

Total files changed: 7

Change summary by file extension:
.yml : +16 -1
.ps1 : +0 -157
.gitignore : +0 -1
.js : +0 -37
.json : +0 -28
.lock : +0 -0

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Backport-7.2.x-Done Backport-7.3.x-Done CL-BuildPackaging Indicates that a PR should be marked as a build or packaging change in the Change Log Large

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants