Initial work

[michaeltlombardi]

PR Summary

This change scaffolds the samples repository for the tutorials, samples, TSToy application, and docs site.

PR Context

With this repository hosting the DSC samples and documentation, this initial work includes defining the docs site and prototyping a model for organizing the tutorials and sample code. Instead of including snapshots of the sample code at every step, this model includes the sample code for the completed tutorial.

The tutorials on the site are duplicated in the navigation, but not definition, into two sections:

1. The tutorials section arranges tutorials by purpose, with a subfolder for each implementation of the tutorial.
2. The languages section arranges tutorials by language, listing only the tutorials already implemented for that language.

At a minimum, we should port the DSC tutorial into this site, reworking it to use the fictional TSToy application. The fictional application's documentation also lives on this site.

While the repository is private/internal, we can't publish the site to GitHub pages or with Netlify for PR validation. You can build and preview the site locally with the following command:

cd _site && hugo serve

[michaeltlombardi]

[pull-request-quantifier-deprecated]

This PR has 4834 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       : +4833 -1
Percentile : 100%

Total files changed: 72

Change summary by file extension:
.gitattributes : +3 -0
.yml : +185 -0
.gitignore : +20 -0
.yaml : +234 -0
.json : +151 -0
.md : +2615 -1
.mod : +58 -0
.sum : +690 -0
.html : +4 -0
.ps1 : +116 -0
.go : +735 -0
.work : +5 -0
app/LICENSE : +17 -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.