diff --git a/.github/PR_PREFERENCES.md b/.github/PR_PREFERENCES.md new file mode 100644 index 0000000..606b1c7 --- /dev/null +++ b/.github/PR_PREFERENCES.md @@ -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 +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 + +- Plain `git` is universally available and works in CI and local shells without + adding additional tooling requirements. +- The web UI provides a clear, auditable PR creation step for maintainers. + +If you'd like this document adjusted (formatting, wording, or to include a +specific workflow your team prefers), please open a PR against the main +branch. diff --git a/PowerShell/system-administration/maintenance/README.md b/PowerShell/system-administration/maintenance/README.md new file mode 100644 index 0000000..2f50113 --- /dev/null +++ b/PowerShell/system-administration/maintenance/README.md @@ -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 + +- 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 + +- `clean-temp-folders.ps1` — remove old files from temporary directories +- `rotate-logs.ps1` — rotate and compress rotating logs + +Thank you for contributing maintenance scripts — please follow the +repository's contribution guidelines in the main `CONTRIBUTING.md`.