Skip to content

Commit 119a388

Browse files
(MAINT) Add repo automation
This change introduces some repository automation from the PowerShell-Docs repositories. In summary: 1. The Pull Request template ensures a standard UX and process for incoming PRs. 2. The checklist workflow uses the PR template to verify that non-admin contributors are following the processes. 3. The dependabot configuration verifies that actions are up to date.
1 parent 454b6f7 commit 119a388

File tree

3 files changed

+68
-0
lines changed

3 files changed

+68
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# PR Summary
2+
3+
<!--
4+
Delete this comment block and summarize your changes and list
5+
related issues here. For example:
6+
7+
This changes fixes problem X in the documentation for Y.
8+
9+
- Fixes #1234
10+
- Resolves #1235
11+
-->
12+
13+
## PR Checklist
14+
15+
<!--
16+
These items are mandatory. For your PR to be reviewed and merged,
17+
ensure you have followed these steps. As you complete the steps,
18+
check each box by replacing the space between the brackets with an
19+
x or by clicking on the box in the UI after your PR is submitted.
20+
-->
21+
22+
- [ ] **Descriptive Title:** This PR's title is a synopsis of the changes it proposes.
23+
- [ ] **Summary:** This PR's summary describes the scope and intent of the change.
24+
- [ ] **Contributor's Guide:** I have read the [contributors guide][contrib].
25+
- [ ] **Style:** This PR adheres to the [style guide][style].
26+
27+
<!--
28+
If your PR is a work in progress, please mark it as a draft or
29+
prefix it with "(WIP)" or "WIP:"
30+
31+
This helps us understand whether or not your PR is ready to review.
32+
-->
33+
34+
[contrib]: https://learn.microsoft.com/powershell/scripting/community/contributing/overview
35+
[style]: https://learn.microsoft.com/powershell/scripting/community/contributing/powershell-style-guide

.github/dependabot.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "github-actions"
4+
directory: "/"
5+
schedule:
6+
interval: "weekly"

.github/workflows/checklist.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Checklist
2+
on:
3+
pull_request:
4+
branches:
5+
- main
6+
types:
7+
- opened
8+
- reopened
9+
- ready_for_review
10+
- edited
11+
- synchronize
12+
permissions:
13+
contents: read
14+
jobs:
15+
Test:
16+
name: Verify Status
17+
runs-on: windows-latest
18+
if: |
19+
!contains(github.event.pull_request.title, 'WIP') &&
20+
!github.event.pull_request.draft
21+
defaults:
22+
run:
23+
shell: pwsh
24+
steps:
25+
- name: Verify Checklist
26+
id: verify_checklist
27+
uses: MicrosoftDocs/PowerShell-Docs/.github/actions/verification/checklist/v1@main

0 commit comments

Comments
 (0)