Skip to content

Commit

Permalink
Add sample path microsoft#2614
Browse files Browse the repository at this point in the history
  • Loading branch information
BernieWhite committed Dec 21, 2024
1 parent d82c704 commit 854975e
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/sample_proposal.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ body:
attributes:
label: Sample path
description: The path to the new sample.
placeholder: samples/rules/name
placeholder: samples/name
validations:
required: true
- type: textarea
Expand Down
6 changes: 6 additions & 0 deletions docs/CHANGELOG-v3.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,12 @@ See [upgrade notes][1] for helpful information when upgrading from previous vers

## Unreleased

What's changed since pre-release v3.0.0-B0351:

- Engineering:
- Migrate samples into PSRule repository by @BernieWhite.
[#2614](https://github.com/microsoft/PSRule/issues/2614)

## v3.0.0-B0351 (pre-release)

What's changed since pre-release v3.0.0-B0342:
Expand Down
34 changes: 34 additions & 0 deletions samples/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Samples

You have reached samples for PSRule.
If you have a question about these samples, please start a discussion on GitHub.

For samples that related to Azure see [PSRule for Azure - samples][1].

[1]: https://github.com/Azure/PSRule.Rules.Azure/tree/main/samples/rules

## Contributing samples

Additional samples can be contributed.
Please use the following structure for your `README.md`.
Replace the comment placeholders with details about your sample.

```markdown
# <name>

<!-- a short one line description which will be included in table of contents -->

## Summary

<!-- describe what your sample does -->

## Usage

<!-- how to use your sample -->

## References

<!-- references to docs that help explain the detail. here is a few to get started, but remove if they are not relevant. -->

- [Conventions](https://microsoft.github.io/PSRule/v3/concepts/PSRule/en-US/about_PSRule_Conventions/#including-with-options)
```
5 changes: 5 additions & 0 deletions samples/azure/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# PSRule samples for Azure

To find samples that related to Azure at [PSRule for Azure - samples][1] as a single central location.

[1]: https://github.com/Azure/PSRule.Rules.Azure/tree/main/samples/rules

0 comments on commit 854975e

Please sign in to comment.