Skip to content

Commit 5622afb

Browse files
committed
Initial module
1 parent f7a88f0 commit 5622afb

33 files changed

+4239
-0
lines changed

.editorconfig

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# EditorConfig is awesome: https://EditorConfig.org
2+
3+
# Top-most EditorConfig file
4+
root = true
5+
6+
[*]
7+
charset = utf-8-bom
8+
indent_size = 4
9+
indent_style = space
10+
trim_trailing_whitespace = true
11+
insert_final_newline = true

.github/CODE_OF_CONDUCT.md

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

.github/CONTRIBUTING.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Contributing
2+
3+
Thanks for your interest in contributing to PSAppDeployToolkit
4+
5+
Whether it's a bug report, new feature, correction, or additional documentation, your feedback and contributions are appreciated.
6+
7+
Please read through this document before submitting any issues or pull requests to ensure all the necessary information is provided to effectively respond to your bug report or contribution.
8+
9+
Please note there is a code of conduct, please follow it in all your interactions with the project.
10+
11+
## Reporting Bugs / Submitting Feature Requests
12+
13+
When filing an issue, please check [existing open](https://github.com/psappdeploytoolkit/psappdeploytoolkit.tools/issues), or [recently closed](https://github.com/psappdeploytoolkit/psappdeploytoolkit.tools/issues?q=is%3Aissue+is%3Aclosed), issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
14+
15+
* A reproducible test case or series of steps
16+
* The version of PSADT that is being used (found in the AppDeployToolkitMain.ps1)
17+
* Any modifications you've made relevant to the bug
18+
* Anything unusual about your environment or deployment
19+
20+
## Contributing via Pull Requests
21+
22+
Contributions via pull requests are much appreciated. Before sending a pull request, please ensure that:
23+
24+
1. You are working against the latest source on the *develop* branch.
25+
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
26+
3. You open an issue to discuss any significant work - I'd hate for your time to be wasted.
27+
28+
To send a pull request, please:
29+
30+
1. Fork the repository.
31+
2. Checkout the *develop* branch
32+
3. Modify the source; please focus on the specific change you are contributing. Please refrain from code styling changes, it will be harder to focus on your change.
33+
4. Ensure local tests pass.
34+
5. Commit to your fork using clear commit messages.
35+
6. Send a pull request, answering any default questions in the pull request interface.
36+
37+
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
38+
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
39+
40+
## Finding contributions to work on
41+
42+
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/psappdeploytoolkit/psappdeploytoolkit.tools/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) issues is a great place to start.
43+
44+
## Code of Conduct
45+
46+
This project has a [Code of Conduct](CODE_OF_CONDUCT.md).
47+
48+
## Licensing
49+
50+
See the [LICENSE](https://github.com/psappdeploytoolkit/psappdeploytoolkit.tools/blob/main/COPYING.Lesser) file for our project's licensing.
Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
name: "🕷️ Bug report"
2+
description: Report errors or unexpected behavior
3+
labels: [ bug, needs-triage ]
4+
title: "[Bug] "
5+
6+
7+
body:
8+
- type: checkboxes
9+
attributes:
10+
label: Prerequisites
11+
options:
12+
- label: Ensure you write a short, descriptive title after [Bug] above.
13+
required: true
14+
- label: Make sure to [search for any existing issues](https://github.com/psappdeploytoolkit/psappdeploytoolkit.tools/issues) before filing a new one.
15+
required: true
16+
- label: Verify you are able to reproduce the issue with the [latest released version](https://www.github.com/psappdeploytoolkit/psappdeploytoolkit.tools/releases/latest)
17+
required: true
18+
19+
- type: input
20+
id: psadttools-version
21+
attributes:
22+
label: PSAppDeployToolkit.Tools version
23+
placeholder: 0.0.1
24+
description: The version of PSAppDeployToolkit you are using
25+
validations:
26+
required: true
27+
28+
- type: input
29+
id: psadt-version
30+
attributes:
31+
label: PSAppDeployToolkit version
32+
placeholder: 4.0.0
33+
description: The version of PSAppDeployToolkit you are using
34+
validations:
35+
required: false
36+
37+
- type: textarea
38+
id: description
39+
attributes:
40+
label: Describe the bug
41+
description: Please enter a detailed description of the bug you are seeing. Include any error messages, screenshots, or other relevant information. If a PSADT log file was created, please also attach it below.
42+
validations:
43+
required: true
44+
45+
- type: textarea
46+
id: steps-to-reproduce
47+
attributes:
48+
label: Steps to reproduce
49+
description: Please provide any required setup and steps to reproduce the behavior.
50+
placeholder: |
51+
1. Go to '...'
52+
2. Click on '....'
53+
3. Scroll down to '....'
54+
value: |
55+
1.
56+
2.
57+
3.
58+
validations:
59+
required: true
60+
61+
- type: textarea
62+
id: environment-data
63+
attributes:
64+
label: Environment data
65+
description: |
66+
The following script will gather environment details that will help with triage and investigation of the issue.
67+
Please run the script in the PowerShell session where you ran into the issue, and paste the verbatim output below.
68+
```powershell
69+
Get-ComputerInfo -Property @('OsName','OSDisplayVersion','OsOperatingSystemSKU','OSArchitecture','WindowsVersion','WindowsProductName','WindowsBuildLabEx','OsLanguage','OsMuiLanguages','KeyboardLayout','TimeZone','HyperVisorPresent','CsPartOfDomain','CsPCSystemType'); dotnet --info
70+
```
71+
render: console
72+
placeholder: |
73+
OsName ...
74+
OSDisplayVersion ...
75+
OsOperatingSystemSKU ...
76+
OsArchitecture ...
77+
WindowsVersion ....
78+
WindowsProductName ...
79+
WindowsBuildLabEx ...
80+
validations:
81+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
contact_links:
2+
- name: Chat with the community
3+
url: https://discord.com/channels/618712310185197588/627204361545842688
4+
about: PSAppDeployToolkit channel on Discord (WinAdmins)
5+
- name: Join in the discussion
6+
url: https://discourse.psappdeploytoolkit.com
7+
about: PSAppDeployToolkit Discourse Forums
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: 🚀 Feature Request
2+
description: Suggest a new feature or improvement (this does not mean you have to implement it)
3+
labels: ["feature-request", "needs-triage"]
4+
title: "[Feature] "
5+
6+
body:
7+
- type: textarea
8+
attributes:
9+
label: Summary of the new feature / enhancement
10+
description: >
11+
A clear and concise description of what the problem is that the new feature would solve. Try formulating it in a user story style (if applicable).
12+
placeholder: "'As a user I want X so that Y...' with X being the being the action and Y being the value of the action."
13+
validations:
14+
required: true
15+
16+
- type: textarea
17+
attributes:
18+
label: Proposed technical implementation details (optional)
19+
placeholder: >
20+
A clear and concise description of what you want to happen. Consider providing an example PowerShell experience with expected result.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# [ADR] - Architectural Decision Record
2+
3+
Please include a summary of any changes. Please also include relevant motivation and context.
4+
5+
## Status
6+
7+
What is the status, such as proposed, accepted, rejected, deprecated, superseded, etc.?
8+
9+
## Context
10+
11+
What is the issue that we're seeing that is motivating this decision or change?
12+
13+
## Decision
14+
15+
What is the change that we're proposing and/or doing?
16+
17+
## Consequences
18+
19+
What becomes easier or more difficult to do because of this change?
20+
21+
## Notes
22+
23+
Any additional notes?
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Pull Request
2+
3+
## Description
4+
5+
Please include a summary of any changes. Please also include relevant motivation and context.
6+
7+
Fixes: #12345
8+
9+
Fixes: <https://github.com/psappdeploytoolkit/psappdeploytoolkit.tools/issues/12345>
10+
11+
## Type of change
12+
13+
- [ ] Bug fix (non-breaking change which fixes an issue)
14+
- [ ] New feature (non-breaking change which adds functionality)
15+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
16+
- [ ] General code cleanup (non-breaking change which improves readability)
17+
18+
## Checklist
19+
20+
- [ ] I am pulling to the **develop** branch
21+
- [ ] I have performed a self-review of my own code
22+
- [ ] I have commented my code, particularly in hard-to-understand areas
23+
- [ ] I have made corresponding changes to the documentation
24+
- [ ] I have tested my changes to prove my fix is effective
25+
- [ ] I have tested that the module can build following my changes
26+
- [ ] I have made sure that any script file-encoding is set to UTF8 with BOM, i.e. unchanged.
27+
28+
## How Has This Been Tested?
29+
30+
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

.github/SECURITY.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Responsible Security Disclosure
2+
3+
## Introduction
4+
5+
Thank you for your interest in PSAppDeployToolkit. We take the security of our software seriously and appreciate the efforts of security researchers in identifying and responsibly disclosing vulnerabilities. This document outlines our responsible disclosure policy and provides guidelines for reporting security vulnerabilities.
6+
7+
## Reporting a Vulnerability
8+
9+
If you believe you have discovered a security vulnerability in PSAppDeployToolkit, we encourage you to report it to us as soon as possible. To report a vulnerability, please follow these steps:
10+
11+
1. Send an email to [[email protected]](mailto:[email protected]) with a detailed description of the vulnerability.
12+
2. Include any relevant information, such as the affected version(s) of the software, steps to reproduce the vulnerability, and any proof-of-concept code or screenshots.
13+
3. Provide your contact information (name, email address) so that we can acknowledge your report and keep you updated on the progress of the fix.
14+
15+
## Responsible Disclosure Guidelines
16+
17+
To ensure the safety and privacy of our users, we kindly request that you adhere to the following guidelines when reporting a vulnerability:
18+
19+
- Do not exploit the vulnerability beyond what is necessary to demonstrate the security issue.
20+
- Do not disclose the vulnerability to others until it has been resolved by the project maintainers.
21+
- Do not perform any actions that could negatively impact the availability or integrity of the software or its users' data.
22+
23+
## Our Commitment
24+
25+
Upon receiving a vulnerability report, we will:
26+
27+
- Acknowledge the receipt of your report within 3 business days.
28+
- Investigate and validate the reported vulnerability.
29+
- Work towards addressing the vulnerability in a timely manner.
30+
- Keep you informed of the progress and resolution of the vulnerability.
31+
32+
## Recognition
33+
34+
We value the contributions of security researchers and may recognize their efforts, subject to their consent and our discretion. If you would like to be acknowledged for your responsible disclosure, please let us know in your initial report.
35+
36+
## Legal Considerations
37+
38+
We will not take any legal action against security researchers who act in good faith and adhere to this responsible disclosure policy. We request that you do not violate any laws or breach any agreements in your research activities.
39+
40+
## Conclusion
41+
42+
By following these guidelines, you are helping us ensure the security and privacy of our software and its users. We appreciate your cooperation and responsible approach to vulnerability disclosure.
43+
44+
Thank you,
45+
The PSAppDeployToolkit Team

.github/SUPPORT.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# PSAppDeployToolkit Support
2+
3+
If you have any problems, please consult the [PSAppDeployToolkit GitHub Issues](https://github.com/psappdeploytoolkit/psappdeploytoolkit.tools/issues) page.
4+
5+
If you do not see your problem captured, please file a [new issue](https://github.com/psappdeploytoolkit/psappdeploytoolkit.tools/issues/new/choose) and follow the provided template.
6+
7+
If you know how to fix the issue, feel free to send a pull request our way. (The [Contribution Guide](https://github.com/psappdeploytoolkit/psappdeploytoolkit.tools/tree/main/.github/CONTRIBUTING.md) apply to that pull request, you may want to give it a read!)

0 commit comments

Comments
 (0)