Skip to content
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

Add pester-docs workflow example to contributing page #123

Merged
merged 3 commits into from Jul 1, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion Tests/Integration/CrossVersionCodeExamples/README.md
Expand Up @@ -2,7 +2,7 @@

This test assures:

- That all `Get-Help` examples render identically on **all** PowerShell versions
- That various `Get-Help` examples render identically on **all** PowerShell versions

Additional information:

Expand Down
2 changes: 1 addition & 1 deletion Tests/Integration/PlaceholderExamples/README.md
Expand Up @@ -3,4 +3,4 @@
This test ensures:

- That the PlatyPS-generated placeholder examples render as expected on all platforms
- That using the `-NoPlaceHolderExamples` switch results in an empty `EXAMPLES` section
- That using the `-NoPlaceHolderExamples` switch results in an empty `.EXAMPLES` Get-Help section
6 changes: 3 additions & 3 deletions Tests/Integration/SeparateMarkdownHeadings/README.md
@@ -1,9 +1,9 @@
# SeparateMarkdownHeadings

This test ensures:
This test ensures that this function:

- That only valid markdown headings (with no blank line beneath them) are processed
- That a blank line is inserted beneath the heading if needed
- Only matches valid markdown headings (and thus with no blank line beneath them)
- Inserts a blank line beneath those heading matches

Additional information:

Expand Down
30 changes: 25 additions & 5 deletions website/docs/contributing.mdx
Expand Up @@ -3,8 +3,14 @@ id: contributing
title: Contributing
---

This module is compiled using the source files found in this
[Source folder](https://github.com/alt3/Docusaurus.PowerShell/tree/main/Source).
This module is compiled using source files found in this
[Source](https://github.com/alt3/Docusaurus.PowerShell/tree/main/Source)
folder.

## Pull Requests

When providing pull requests, please make sure to include an appropriate
[Pester test](https://github.com/alt3/Docusaurus.PowerShell/tree/main/Tests).

## Installation

Expand Down Expand Up @@ -40,7 +46,21 @@ Supports the Pester `-Output` parameter for more testing details.

:::

## Test Cases
## Example

Imagine developing the Alt3-module and testing it against the
[Pester documentation website](https://pester.dev/) to see the effect
of your code changes.

The below steps would:

Please make sure to include an [appropriate Pester test](https://github.com/alt3/Docusaurus.PowerShell/tree/main/Tests)
when providing code changes.
1. Build a fresh version of the Alt3-module containing your code changes
2. Import your version of the Alt3-module into your current session
3. Use your in-session Alt3-module to generate the Pester Docusaurus command pages

```
cd Alt3.Docusaurus.Powershell
.\build-module.ps1
cd ..\pester-docs\
.\generate-command-reference.ps1 -SkipModuleImport
```