Skip to content

Commit 3b19ddd

Browse files
committed
Add test module
1 parent 11e1b94 commit 3b19ddd

26 files changed

Lines changed: 792 additions & 0 deletions

tests/TestModule/.gitattributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* -crlf
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# How to contribute
2+
3+
Contributions to TestModule are highly encouraged and desired.
4+
Below are some guidelines that will help make the process as smooth as possible.
5+
6+
## Getting Started
7+
8+
- Make sure you have a [GitHub account](https://github.com/signup/free)
9+
- Submit a new issue, assuming one does not already exist.
10+
- Clearly describe the issue including steps to reproduce when it is a bug.
11+
- Make sure you fill in the earliest version that you know has the issue.
12+
- Fork the repository on GitHub
13+
14+
## Suggesting Enhancements
15+
16+
I want to know what you think is missing from TestModule and how it can be made better.
17+
18+
- When submitting an issue for an enhancement, please be as clear as possible about why you think the enhancement is needed and what the benefit of it would be.
19+
20+
## Making Changes
21+
22+
- From your fork of the repository, create a topic branch where work on your change will take place.
23+
- To quickly create a topic branch based on master; `git checkout -b my_contribution master`.
24+
Please avoid working directly on the `master` branch.
25+
- Make commits of logical units.
26+
- Check for unnecessary whitespace with `git diff --check` before committing.
27+
- Please follow the prevailing code conventions in the repository.
28+
Differences in style make the code harder to understand for everyone.
29+
- Make sure your commit messages are in the proper format.
30+
31+
```
32+
Add more cowbell to Get-Something.ps1
33+
34+
The functionality of Get-Something would be greatly improved if there was a little
35+
more 'pizzazz' added to it. I propose a cowbell. Adding more cowbell has been
36+
shown in studies to both increase one's mojo, and cement one's status
37+
as a rock legend.
38+
```
39+
40+
- Make sure you have added all the necessary Pester tests for your changes.
41+
- Run _all_ Pester tests in the module to assure nothing else was accidentally broken.
42+
43+
## Documentation
44+
45+
I am infallible and as such my documenation needs no corectoin.
46+
In the highly unlikely event that that is _not_ the case, commits to update or add documentation are highly apprecaited.
47+
48+
## Submitting Changes
49+
50+
- Push your changes to a topic branch in your fork of the repository.
51+
- Submit a pull request to the main repository.
52+
- Once the pull request has been reviewed and accepted, it will be merged with the master branch.
53+
- Celebrate
54+
55+
## Additional Resources
56+
57+
- [General GitHub documentation](https://help.github.com/)
58+
- [GitHub forking documentation](https://guides.github.com/activities/forking/)
59+
- [GitHub pull request documentation](https://help.github.com/send-pull-requests/)
60+
- [GitHub Flow guide](https://guides.github.com/introduction/flow/)
61+
- [GitHub's guide to contributing to open source projects](https://guides.github.com/activities/contributing-to-open-source/)
62+
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<!--- Provide a general summary of the issue in the Title above -->
2+
3+
## Expected Behavior
4+
<!--- If you're describing a bug, tell us what should happen -->
5+
<!--- If you're suggesting a change/improvement, tell us how it should work -->
6+
7+
## Current Behavior
8+
<!--- If describing a bug, tell us what happens instead of the expected behavior -->
9+
<!--- If suggesting a change/improvement, explain the difference from current behavior -->
10+
11+
## Possible Solution
12+
<!--- Not obligatory, but suggest a fix/reason for the bug, -->
13+
<!--- or ideas how to implement the addition or change -->
14+
15+
## Steps to Reproduce (for bugs)
16+
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
17+
<!--- reproduce this bug. Include code to reproduce, if relevant -->
18+
1.
19+
2.
20+
3.
21+
4.
22+
23+
## Context
24+
<!--- How has this issue affected you? What are you trying to accomplish? -->
25+
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
26+
27+
## Your Environment
28+
<!--- Include as many relevant details about the environment you experienced the bug in -->
29+
* Module version used:
30+
* Operating System and PowerShell version:
31+
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
<!--- Provide a general summary of your changes in the Title above -->
2+
3+
## Description
4+
<!--- Describe your changes in detail -->
5+
6+
## Related Issue
7+
<!--- This project only accepts pull requests related to open issues -->
8+
<!--- If suggesting a new feature or change, please discuss it in an issue first -->
9+
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
10+
<!--- Please link to the issue here: -->
11+
12+
## Motivation and Context
13+
<!--- Why is this change required? What problem does it solve? -->
14+
15+
## How Has This Been Tested?
16+
<!--- Please describe in detail how you tested your changes. -->
17+
<!--- Include details of your testing environment, and the tests you ran to -->
18+
<!--- see how your change affects other areas of the code, etc. -->
19+
20+
## Screenshots (if appropriate):
21+
22+
## Types of changes
23+
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
24+
- [ ] Bug fix (non-breaking change which fixes an issue)
25+
- [ ] New feature (non-breaking change which adds functionality)
26+
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
27+
28+
## Checklist:
29+
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
30+
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
31+
- [ ] My code follows the code style of this project.
32+
- [ ] My change requires a change to the documentation.
33+
- [ ] I have updated the documentation accordingly.
34+
- [ ] I have read the **CONTRIBUTING** document.
35+
- [ ] I have added tests to cover my changes.
36+
- [ ] All new and existing tests passed.
37+

tests/TestModule/.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Don't check in the MyOutput dir
2+
docs/
3+
Output/
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
// See http://go.microsoft.com/fwlink/?LinkId=827846
3+
// for the documentation about the extensions.json format
4+
"recommendations": [
5+
"ms-vscode.PowerShell",
6+
"DavidAnson.vscode-markdownlint"
7+
]
8+
}
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"files.trimTrailingWhitespace": true,
3+
"files.insertFinalNewline": true,
4+
"editor.insertSpaces": true,
5+
"editor.tabSize": 4,
6+
"powershell.codeFormatting.preset": "OTBS"
7+
}
Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
{
2+
// See https://go.microsoft.com/fwlink/?LinkId=733558
3+
// for the documentation about the tasks.json format
4+
"version": "2.0.0",
5+
6+
// Start PowerShell (pwsh on *nix)
7+
"windows": {
8+
"options": {
9+
"shell": {
10+
"executable": "powershell.exe",
11+
"args": [ "-NoProfile", "-ExecutionPolicy", "Bypass", "-Command" ]
12+
}
13+
}
14+
},
15+
"linux": {
16+
"options": {
17+
"shell": {
18+
"executable": "/usr/bin/pwsh",
19+
"args": [ "-NoProfile", "-Command" ]
20+
}
21+
}
22+
},
23+
"osx": {
24+
"options": {
25+
"shell": {
26+
"executable": "/usr/local/bin/pwsh",
27+
"args": [ "-NoProfile", "-Command" ]
28+
}
29+
}
30+
},
31+
32+
"tasks": [
33+
{
34+
"label": "Clean",
35+
"type": "shell",
36+
"command": "${cwd}/build.ps1 -Task Clean -Verbose"
37+
},
38+
{
39+
"label": "Test",
40+
"type": "shell",
41+
"command": "${cwd}/build.ps1 -Task Test -Verbose",
42+
"group": {
43+
"kind": "test",
44+
"isDefault": true
45+
},
46+
"problemMatcher": "$pester"
47+
},
48+
{
49+
"label": "Analyze",
50+
"type": "shell",
51+
"command": "${cwd}/build.ps1 -Task Analyze -Verbose"
52+
},
53+
{
54+
"label": "Pester",
55+
"type": "shell",
56+
"command": "${cwd}/build.ps1 -Task Pester -Verbose",
57+
"problemMatcher": "$pester"
58+
},
59+
{
60+
"label": "Build",
61+
"type": "shell",
62+
"command": "${cwd}/build.ps1 -Task Build -Verbose",
63+
"group": {
64+
"kind": "build",
65+
"isDefault": true
66+
}
67+
},
68+
{
69+
"label": "Publish",
70+
"type": "shell",
71+
"command": "${cwd}/build.ps1 -Task Publish -Verbose"
72+
}
73+
]
74+
}

tests/TestModule/CHANGELOG.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Change Log
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](http://keepachangelog.com/)
6+
and this project adheres to [Semantic Versioning](http://semver.org/).
7+
8+
## [0.1.0] Unreleased
9+
Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, sexual identity and
10+
orientation, or sexual proclivities between consenting adults.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
26+
* Trolling, insulting/derogatory comments, and personal or political attacks
27+
* Public or private harassment
28+
* Publishing others' private information, such as a physical or electronic
29+
address, without explicit permission
30+
* Other conduct which could reasonably be considered inappropriate in a
31+
professional setting
32+
33+
## Our Responsibilities
34+
35+
Project maintainers are responsible for clarifying the standards of acceptable
36+
behavior and are expected to take appropriate and fair corrective action in
37+
response to any instances of unacceptable behavior.
38+
39+
Project maintainers have the right and responsibility to remove, edit, or
40+
reject comments, commits, code, wiki edits, issues, and other contributions
41+
that are not aligned to this Code of Conduct, or to ban temporarily or
42+
permanently any contributor for other behaviors that they deem inappropriate,
43+
threatening, offensive, or harmful.
44+
45+
## Scope
46+
47+
This Code of Conduct applies both within project spaces and in public spaces
48+
when an individual is representing the project or its community. Examples of
49+
representing a project or community include using an official project e-mail
50+
address, posting via an official social media account, or acting as an appointed
51+
representative at an online or offline event. Representation of a project may be
52+
further defined and clarified by project maintainers.
53+
54+
## Enforcement
55+
56+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
57+
reported by contacting the project team at [somebody@example.com](mailto:somebody@example.com). All
58+
complaints will be reviewed and investigated and will result in a response that
59+
is deemed necessary and appropriate to the circumstances. The project team is
60+
obligated to maintain confidentiality with regard to the reporter of an incident.
61+
Further details of specific enforcement policies may be posted separately.
62+
63+
Project maintainers who do not follow or enforce the Code of Conduct in good
64+
faith may face temporary or permanent repercussions as determined by other
65+
members of the project's leadership.
66+
67+
## Attribution
68+
69+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4.1,
70+
available at [http://contributor-covenant.org/version/1/4/1][version]
71+
72+
[homepage]: http://contributor-covenant.org
73+
[version]: http://contributor-covenant.org/version/1/4/
74+

0 commit comments

Comments
 (0)