-
Notifications
You must be signed in to change notification settings - Fork 0
Fix/markdownlint readmes #3
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,44 @@ | ||||||
| # Pull Request Preferences | ||||||
|
|
||||||
| This repository prefers plain Git for local operations and the GitHub web UI for | ||||||
| creating pull requests. This note documents that preference so contributors and | ||||||
| automation respect the chosen workflow. | ||||||
|
|
||||||
| Recommendations | ||||||
|
|
||||||
| - Use git to create branches, stage, commit, and push. Example: | ||||||
|
|
||||||
| ```powershell | ||||||
| # create branch, stage, commit and push | ||||||
| git checkout -b fix/my-change | ||||||
| git add <files> | ||||||
| git commit -m "Describe change" | ||||||
| git push -u origin fix/my-change | ||||||
| ``` | ||||||
|
|
||||||
| - Create the pull request using the GitHub web UI by visiting the branch URL. | ||||||
|
|
||||||
| Example (replace placeholders with actual values): | ||||||
|
|
||||||
| - `https://github.com/OWNER/REPO/pull/new/BRANCH` | ||||||
|
|
||||||
| For this repository the shortcut after pushing a branch is: | ||||||
|
|
||||||
| - `https://github.com/AprilDeFeu/Scripts/pull/new/BRANCH` | ||||||
|
|
||||||
| - Avoid using the GitHub CLI (`gh`) in automation for this repo. If you want to | ||||||
| use `gh` in your local environment, that is fine — but do not rely on CI or | ||||||
| repository-side automation that requires `gh` to be present. | ||||||
|
|
||||||
| - If you integrate other tools (for example GitKraken or GitHub Apps), only do | ||||||
| so after confirming credentials and access are explicitly authorized. | ||||||
|
|
||||||
| Why this preference | ||||||
|
||||||
| Why this preference | |
| ## Why this preference |
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,27 @@ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # PowerShell — system-administration/maintenance | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| This folder contains PowerShell scripts focused on system maintenance tasks. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Typical responsibilities include package cleanup, service health checks, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| temporary-file housekeeping, and other routine maintenance utilities. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Usage and placement | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - Place small, single-purpose maintenance scripts here. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - For complex tools with multiple files, include a top-level README and a | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| subfolder with implementation files. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Naming and contribution | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Naming and contribution | |
| ## Naming and contribution |
Copilot
AI
Nov 12, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The section headings "Usage and placement", "Naming and contribution", and "Examples" should be formatted as proper Markdown headings (using ##) instead of plain text. This improves document structure and navigation.
| Usage and placement | |
| - Place small, single-purpose maintenance scripts here. | |
| - For complex tools with multiple files, include a top-level README and a | |
| subfolder with implementation files. | |
| Naming and contribution | |
| - Use descriptive kebab-case names, e.g. `clean-temp-folders.ps1` or | |
| `check-service-health.ps1`. | |
| - Add header documentation (comment-based help) and examples for each script. | |
| - Include `-WhatIf` support for potentially destructive operations. | |
| Examples | |
| ## Usage and placement | |
| - Place small, single-purpose maintenance scripts here. | |
| - For complex tools with multiple files, include a top-level README and a | |
| subfolder with implementation files. | |
| ## Naming and contribution | |
| - Use descriptive kebab-case names, e.g. `clean-temp-folders.ps1` or | |
| `check-service-health.ps1`. | |
| - Add header documentation (comment-based help) and examples for each script. | |
| - Include `-WhatIf` support for potentially destructive operations. | |
| ## Examples |
Copilot
AI
Nov 12, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The section heading "Examples" should be formatted as a proper Markdown heading (using ##) instead of plain text. This improves document structure and navigation.
| Examples | |
| ## Examples |
Copilot
AI
Nov 12, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo in comment: "rotating logs" should be "log files" for clarity. The phrase "rotate and compress rotating logs" is redundant.
| - `rotate-logs.ps1` — rotate and compress rotating logs | |
| - `rotate-logs.ps1` — rotate and compress log files |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The section headings "Recommendations" and "Why this preference" should be formatted as proper Markdown headings (using
##) instead of plain text. This improves document structure and navigation.