Sitelet https://github.com/TheFreeman193/Scripts/blob/main/.github/pull_request_template.md
Skip to content

pull_request_template.md

Latest commit

 

History

History
90 lines (59 loc) · 3.4 KB

pull_request_template.md

File metadata and controls

90 lines (59 loc) · 3.4 KB
Raw

FEATURE | BUG FIX

Which script?

Describe which script this pull request is for, including the location within this repo.

e.g. PowerShell/Scripts/Some-Script.ps1

What's it do?

A clear and concise description of the feature/improvement or bug fix this pull request creates.

If this resolves a feature request or bug issue, tag it using a hash/pound symbol # and number e.g.

This resolves #1

or:

This fixes #1

or:

This closes #1

Also include any relevant code, using code fences and a language hint [e.g. java, powershell] like below:

.\Some-Script.ps1 -NewParameter "Does something new and fancy"
.\Some-Script.ps1 -FixedParameter "No longer fails with","multiple strings"

Why's it a good one?

If this isn't a bug fix, provide a clear and concise description of why you think this should be merged. If it's a new feature, what does it add to the script?

Screenshots

If applicable, add screenshots to help explain what this change will do. These can be hosted on GitHub, or as links to uploads on one of the following image hosting sites:

Additional notes

Add any other context or relevant information here. This includes technical details, security considerations, and attributions for code included that was written by others (third-party). Any attributions must also be in the code as comments or in comment-based help. Any third-party code must be in the public domain or have a license compatible with the MIT license, and this license should be included. Submissions with third-party code will be considered on a case-by-case basis.

Checklist

Make sure you fulfill each of the following requirements. The ready for merge check can be left unticked if you want amendments and suggestions before a decision is made.

  • Pull request identifies the script being improved (Which script?).
  • Pull request has a descriptive title and description (What's it do?).
  • Pull request is justified with relevant context if it's not a bug fix (Why's it a good one?).
  • Any changes to the user experience are documented correctly with comment-based help.
  • If a test suite exists for the script, changes have been tested and/or tests amended.
  • I confirm that the changes are my own work and any code included that was written by others is attributed.

Ready for merge

  • Pull request is not a WIP and is ready for merge.