Skip to content

Conversation

@daxian-dbw
Copy link
Member

@daxian-dbw daxian-dbw commented Nov 7, 2022

PR Summary

The pre-generated files experimental-feature-windows.json and experimental-feature-linux.json exist only for building purpose -- so that the powershell.config.json file can include all experimental features for the pre-release builds to enable all experimental features by default. (A little background context -- you cannot start the newly built pwsh when doing cross-compilation for ARM architectures)

However, it turns out this becomes a burden to the developer who is working on an experimental feature -- they have to update those 2 files to make the new experimental feature enabled in CI builds and private builds. This makes declaring an experimental feature harder and more confusing, as there is no documentation saying that those 2 files need to be updated as part of creating an experimental feature.

This PR update Start-PSBuild to avoid depending on those 2 files for private builds and CI builds. For release builds, since we have a GitHub Action workflow to update those 2 files daily, we should be good.

PR Checklist

@pull-request-quantifier-deprecated

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


Quantification details

Label      : Extra Small
Size       : +19 -11
Percentile : 12%

Total files changed: 2

Change summary by file extension:
.psm1 : +17 -11
.yml : +2 -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.

@daxian-dbw
Copy link
Member Author

daxian-dbw commented Nov 7, 2022

It's easier to review by ignoring the white spaces:
https://github.com/PowerShell/PowerShell/pull/18484/files?w=1

@adityapatwardhan adityapatwardhan merged commit 1809328 into PowerShell:master Nov 10, 2022
@daxian-dbw daxian-dbw deleted the exp-build branch November 10, 2022 01:30
@iSazonov iSazonov added the CL-BuildPackaging Indicates that a PR should be marked as a build or packaging change in the Change Log label Nov 10, 2022
@ghost
Copy link

ghost commented Dec 20, 2022

🎉v7.4.0-preview.1 has been released which incorporates this pull request.:tada:

Handy links:

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

Labels

CL-BuildPackaging Indicates that a PR should be marked as a build or packaging change in the Change Log Extra Small

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants