René's URL Explorer Experiment


Title: The new `docs\Rules\README.md` format causes merge issues · Issue #2220 · PowerShell/PSScriptAnalyzer · GitHub

Open Graph Title: The new `docs\Rules\README.md` format causes merge issues · Issue #2220 · PowerShell/PSScriptAnalyzer

X Title: The new `docs\Rules\README.md` format causes merge issues · Issue #2220 · PowerShell/PSScriptAnalyzer

Description: (this concerns contribution -documentation- issue) As far as I can tell, the new docs\Rules\README.md setup (PR2196) will cause a merge conflict with every new rule added to the analyzer repo like: #2186 and #2183. The new format change:...

Open Graph Description: (this concerns contribution -documentation- issue) As far as I can tell, the new docs\Rules\README.md setup (PR2196) will cause a merge conflict with every new rule added to the analyzer repo like:...

X Description: (this concerns contribution -documentation- issue) As far as I can tell, the new docs\Rules\README.md setup (PR2196) will cause a merge conflict with every new rule added to the analyzer repo like:...

Opengraph URL: https://github.com/PowerShell/PSScriptAnalyzer/issues/2220

X: @github

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"The new `docs\\Rules\\README.md` format causes merge issues","articleBody":"(this concerns contribution -documentation- issue)\n\nAs far as I can tell, the new [`docs\\Rules\\README.md`](https://raw.githubusercontent.com/PowerShell/PSScriptAnalyzer/refs/heads/main/docs/Rules/README.md) setup ([PR2196](https://github.com/PowerShell/PSScriptAnalyzer/pull/2196)) will cause a merge conflict with every new rule added to the analyzer repo like: [#2186](https://github.com/PowerShell/PSScriptAnalyzer/pull/2186/conflicts) and [#2183](https://github.com/PowerShell/PSScriptAnalyzer/pull/2183/conflicts).\n\nThe new format change:\n* Update rules index (docs/Rules/README.md) to a new “Default state” model and add link references for maintainability\nWhich results in a table like:\n\n```\n|                        Rule                        |  Severity   | Default state  | Configurable |\n| -------------------------------------------------- | ----------- | :------------: | :----------: |\n| [AlignAssignmentStatement][02]                     | Warning     |    Disabled    |     Yes      |\n| [AvoidAssignmentToAutomaticVariable][03]           | Warning     | Always enabled |              |\n| [AvoidDefaultValueForMandatoryParameter][04]       | Warning     | Always enabled |              |\n...\n```\n\nAnd a reference list like:\n```\n\u003c!-- link references -->\n[01]: ../using-scriptanalyzer.md#suppressing-rules\n[02]: AlignAssignmentStatement.md\n[03]: AvoidAssignmentToAutomaticVariable.md\n[04]: AvoidDefaultValueForMandatoryParameter.md\n[05]: AvoidDefaultValueSwitchParameter.md\n...\n```\n\nMight be a beter practice for a static `README.md`, it isn't for a dynamic `README.md` that needs to be updated with each new rule. The difficulty is because the rule list is alphabetically and inserting a new rule document to the list requires to update **all following** rules and reference links (that are not related to the new rule PR). Doing so, is in fact rather difficult to maintain and error prone.\n\nA workaround might simply using the next available reference number (e.g. `[81]`) but that would then appear somewhere in the middle of the list (depending on the rule _name_) with is quite inconsistent and doesn't add much value to the \"maintainability\".","author":{"url":"https://github.com/iRon7","@type":"Person","name":"iRon7"},"datePublished":"2026-09-29T11:07:37Z","url":"https://github.com/PowerShell/PSScriptAnalyzer/issues/2220"}

react-profiling0
react-import-mapreact,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322
route-pattern/_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format)
route-controllervoltron_issues_fragments
route-actionissue_layout
fetch-noncev2:c52ad717-d613-0ebb-9c45-5c7cf1db8fb8
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-idBC60:2A4E9B:28DD5E:3625A9:6AFCE22C
html-safe-nonce12dae5278e8d1e164a4e924068589e94bf2a9e2972a20fd4925dbcc9875a3aed
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCQzYwOjJBNEU5QjoyOERENUU6MzYyNUE5OjZBRkNFMjJDIiwidmlzaXRvcl9pZCI6IjI2MDY4MTYxMTYwMTU2ODMwMCIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9
visitor-hmacdaa42ac147bfe8592c3bfdea6049bde69e646214c5005fac16ca9e217586d350
hovercard-subject-tagissue:5629526912
github-keyboard-shortcutsrepository,issues,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///voltron/issues_fragments/issue_layout
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/PowerShell/PSScriptAnalyzer/2220/issue_layout
twitter:imagehttps://opengraph.githubassets.com/4c3d30b42bf43995c91a39980483a03ef433ed726fe3a9eadf21614526aea13a/PowerShell/PSScriptAnalyzer/issues/2220
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/4c3d30b42bf43995c91a39980483a03ef433ed726fe3a9eadf21614526aea13a/PowerShell/PSScriptAnalyzer/issues/2220
og:image:alt(this concerns contribution -documentation- issue) As far as I can tell, the new docs\Rules\README.md setup (PR2196) will cause a merge conflict with every new rule added to the analyzer repo like:...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernameiRon7
hostnamegithub.com
expected-hostnamegithub.com
None0c05b7eb5b95e29725d01bb1f560a020e3fafd0f033c6b9ed3918fa3161254dd
turbo-cache-controlno-preview
go-importgithub.com/PowerShell/PSScriptAnalyzer git https://github.com/PowerShell/PSScriptAnalyzer.git
octolytics-dimension-user_id11524380
octolytics-dimension-user_loginPowerShell
octolytics-dimension-repository_id33149177
octolytics-dimension-repository_nwoPowerShell/PSScriptAnalyzer
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id33149177
octolytics-dimension-repository_network_root_nwoPowerShell/PSScriptAnalyzer
turbo-body-classeslogged-out env-production page-responsive
disable-turbofalse
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release79d9154e55368884c8c93766ba4fee076343d37f
ui-targetfull
theme-color#1e2327
color-schemelight dark
react-app-nameissues

Links:

Skip to contenthttps://github.com/PowerShell/PSScriptAnalyzer/issues/2220#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2FPowerShell%2FPSScriptAnalyzer%2Fissues%2F2220
GitHubRepository hosting, code review, and collaborationhttps://github.com/platform
CopilotAI coding agent for tasks, projects, and automated workhttps://github.com/features/copilot
ActionsCI/CD and automationhttps://github.com/features/actions
Code QualityQuality analysis, fixes, and enforcementhttps://github.com/features/code-quality
CodespacesCloud development environmentshttps://github.com/features/codespaces
Code SecurityVulnerability detection and remediationhttps://github.com/security/advanced-security/code-security
Secret ProtectionSecret scanning and leak preventionhttps://github.com/security/advanced-security/secret-protection
All Featureshttps://github.com/features
Documentationhttps://docs.github.com/en
Traininghttps://learn.github.com/skills
Certificationshttps://learn.github.com/credentials
Build with Copilothttps://github.com/features/ai
Customize Copilothttps://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview
Integrationshttps://github.com/marketplace
Trending reposhttps://github.com/trending
GitHub Sponsorshttps://github.com/open-source/sponsors
Developer articleshttps://github.com/resources/articles
ChangelogYour source for the latest features, improvements, and fixes across GitHub products, all in one place.https://github.blog/changelog/
Enterpriseshttps://github.com/enterprise
Teamhttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
See all industrieshttps://github.com/solutions/industry
Why GitHubhttps://github.com/why-github
Customer Storieshttps://github.com/customer-stories
Business insightshttps://github.com/solutions/executive-insights
Trust Centerhttps://github.com/trust-center
GitHub Advanced SecurityEnterprise-grade code securityhttps://github.com/security/advanced-security
Copilot for businessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Documentationhttps://docs.github.com/en
Resource centerhttps://github.com/resources
Bloghttps://github.blog/
Events & webinarshttps://github.com/resources/events
Community Forumhttps://github.com/orgs/community/discussions
Customer Storieshttps://github.com/customer-stories
Integrationshttps://github.com/marketplace
Customer supporthttps://help.github.com/
Traininghttps://learn.github.com/skills
GitHub Statushttps://www.githubstatus.com/
Abouthttps://github.com/about
Partnershttps://github.com/partners
Changeloghttps://github.blog/changelog/
GitHub UniverseThe event for developers, by developers — talks, workshops, and what’s next for GitHub.https://githubuniverse.com/
Pricinghttps://github.com/pricing
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2FPowerShell%2FPSScriptAnalyzer%2Fissues%2F2220
Sign uphttps://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fvoltron%2Fissues_fragments%2Fissue_layout&source=header-repo&source_repo=PowerShell%2FPSScriptAnalyzer
Reloadhttps://github.com/PowerShell/PSScriptAnalyzer/issues/2220
Reloadhttps://github.com/PowerShell/PSScriptAnalyzer/issues/2220
Reloadhttps://github.com/PowerShell/PSScriptAnalyzer/issues/2220
PowerShellhttps://github.com/PowerShell
PSScriptAnalyzerhttps://github.com/PowerShell/PSScriptAnalyzer
Codehttps://github.com/PowerShell/PSScriptAnalyzer
Issues407 (407)https://github.com/PowerShell/PSScriptAnalyzer/issues
Pull requests34 (34)https://github.com/PowerShell/PSScriptAnalyzer/pulls
Discussionshttps://github.com/PowerShell/PSScriptAnalyzer/discussions
Actionshttps://github.com/PowerShell/PSScriptAnalyzer/actions
Projectshttps://github.com/PowerShell/PSScriptAnalyzer/projects
Wikihttps://github.com/PowerShell/PSScriptAnalyzer/wiki
Security and qualityhttps://github.com/PowerShell/PSScriptAnalyzer/security
Insightshttps://github.com/PowerShell/PSScriptAnalyzer/insights
https://github.com/PowerShell/PSScriptAnalyzer
New issuehttps://github.com/login?return_to=https://github.com/PowerShell/PSScriptAnalyzer/issues/2220
New issuehttps://github.com/login?return_to=https://github.com/PowerShell/PSScriptAnalyzer/issues/2220
#2301https://github.com/PowerShell/PSScriptAnalyzer/pull/2301
The new docs\Rules\README.md format causes merge issueshttps://github.com/PowerShell/PSScriptAnalyzer/issues/2220#top
#2301https://github.com/PowerShell/PSScriptAnalyzer/pull/2301
https://github.com/iRon7
iRon7https://github.com/iRon7
on Sep 29, 2026https://github.com/PowerShell/PSScriptAnalyzer/issues/2220#issue-5629526912
docs\Rules\README.mdhttps://raw.githubusercontent.com/PowerShell/PSScriptAnalyzer/refs/heads/main/docs/Rules/README.md
PR2196https://github.com/PowerShell/PSScriptAnalyzer/pull/2196
#2186https://github.com/PowerShell/PSScriptAnalyzer/pull/2186/conflicts
#2183https://github.com/PowerShell/PSScriptAnalyzer/pull/2183/conflicts
Sign up for freehttps://github.com/signup?return_to=https://github.com/PowerShell/PSScriptAnalyzer/issues/2220
Sign in to commenthttps://github.com/login?return_to=https://github.com/PowerShell/PSScriptAnalyzer/issues/2220
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.