Skip to content
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.

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

Migrate user docs to Docs repo #19871

Merged
merged 6 commits into from Jul 10, 2023
Merged

Conversation

sdwheeler
Copy link
Collaborator

PR Summary

The source repo should only contain docs for contributing to or maintaining the project. User-focused documentation has been moved to the MicrosoftDocs/PowerShell-Docs repo.

PR Context

Removed files from the docs/learning-powershell folder and update the FAQ.

PR Checklist

@sdwheeler
Copy link
Collaborator Author

@SteveL-MSFT We talked about moving this content in Shiproom.

@ghost ghost added the Review - Needed The PR is being reviewed label Jul 7, 2023
@ghost
Copy link

ghost commented Jul 7, 2023

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

@sdwheeler sdwheeler added the CommunityDay-Small A small PR that the PS team has identified to prioritize to review label Jul 10, 2023
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

@daxian-dbw daxian-dbw added CL-Docs Indicates that a PR should be marked as a documentation change in the Change Log and removed Review - Needed The PR is being reviewed labels Jul 10, 2023
docs/FAQ.md Outdated Show resolved Hide resolved
@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 10, 2023
@ghost ghost added Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept and removed Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept labels Jul 10, 2023
Copy link
Member

@andyleejordan andyleejordan left a comment

Choose a reason for hiding this comment

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

LGTM! And I double-checked the links.

@pull-request-quantifier-deprecated

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


Quantification details

Label      : Extra Large
Size       : +98 -644
Percentile : 91.4%

Total files changed: 8

Change summary by file extension:
.spelling : +13 -0
.md : +85 -644

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.

@daxian-dbw daxian-dbw merged commit d9fff5b into PowerShell:master Jul 10, 2023
41 checks passed
@sdwheeler sdwheeler deleted the sdw-user-docs branch July 13, 2023 13:05
VindSkyggen pushed a commit to VindSkyggen/PowerShell that referenced this pull request Dec 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CL-Docs Indicates that a PR should be marked as a documentation change in the Change Log CommunityDay-Small A small PR that the PS team has identified to prioritize to review Extra Large
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants