Simplify PR Template #25268
Simplify PR Template #25268
Conversation
TravisEz13
added
the
CL-BuildPackaging
|
/azp run PowerShell-CI-linux-packaging, PowerShell-Windows-Packaging-CI |
|
Azure Pipelines could not run because the pipeline triggers exclude this branch/path. |
|
Before this is merged we should have it properly discussed/documented in either an issue or discussion as to why we think it makes sense to remove it also by removing it we have less safe guards in place for downstrem dependencies Personaly I feel this section should stay and we should be tighter about when there are downstream impacts as to allow those impacted to be able to make changes as quickly as they can. |
Co-authored-by: Dongbo Wang <dongbow@microsoft.com>
|
I think the vast majority of people are not looking at this. This doesn't add any significant safeguards as most people don't know what interfaces these tools use. The tools would need to add tests as @iSazonov mentioned https://github.com/PowerShell/PowerShell/pull/25268/files#r2024016139. We already have acceptance tests from modules. I don't see any reason we will not allow acceptance tests from tools owned by the PowerShell team if they conform to our test patterns.
|
|
/azp run PowerShell-CI-linux-packaging, PowerShell-Windows-Packaging-CI |
|
Azure Pipelines could not run because the pipeline triggers exclude this branch/path. |
|
📣 Hey @@TravisEz13, how did we do? We would love to hear your feedback with the link below! 🗣️ 🔗 https://aka.ms/PSRepoFeedback |
Co-authored-by: Dongbo Wang <dongbow@microsoft.com>
Co-authored-by: Dongbo Wang <dongbow@microsoft.com>
|
@TravisEz13 Prettier should use @andyleejordan and I recently dealt with this in PowerShell/vscode-powershell#5190 |
|
Also, in terms of code style and formatting, has the PowerShell repo defined which tools are to be the "source of truth"? Is prettier now intended to be the formatter for all formats except C# and PowerShell (including JSON)? This affects how I update the vscode tooling in #25274 |
7 participants
PR Summary
This pull request includes updates to the pull request template, workflow configuration, and the addition of new configuration files for code formatting and linting. The most important changes are summarized below:
Pull Request Template Updates:
.github/PULL_REQUEST_TEMPLATE.md: Modified the instructions for marking a PR as ready to merge, replacing "work in progress" with "Draft Pull Request" and removing the tooling impact section. [1] [2]Workflow Configuration:
.github/workflows/markdownLink.yml: Added a step to load super-linter configuration from an environment file and included instructions for handling linter failures.Code Formatting and Linting:
.prettierrc: Added a new Prettier configuration file to enforce consistent code formatting.tools/super-linter/config/super-linter.env: Added a new environment configuration file for super-linter settings.tools/super-linter/super-linter.ps1: Added a new PowerShell script to run super-linter locally using Docker.PR Context
I don't believe people review this section.
Additionally, I added a script to run super-linter locally using docker, and made a common configuration for the GH Action and the local scenario.
PR Checklist
.h,.cpp,.cs,.ps1and.psm1files have the correct copyright headerWIP:or[ WIP ]to the beginning of the title (theWIPbot will keep its status check atPendingwhile the prefix is present) and remove the prefix when the PR is ready.- [ ] Issue filed: