-
Notifications
You must be signed in to change notification settings - Fork 52
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
V3 Refactor #169
base: master
Are you sure you want to change the base?
V3 Refactor #169
Changes from 12 commits
36be378
b69091b
2ea4adc
13d6e27
f1ec5b9
ab30de0
1002e66
3d088a1
d4a9d77
27afc3b
fe7e8cd
feee52c
47f7ea7
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
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, gender identity and expression, level of experience, | ||
education, socio-economic status, nationality, personal appearance, race, | ||
religion, or sexual identity and orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment | ||
include: | ||
|
||
* Using welcoming and inclusive language | ||
* Being respectful of differing viewpoints and experiences | ||
* Gracefully accepting constructive criticism | ||
* Focusing on what is best for the community | ||
* Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery and unwelcome sexual attention or | ||
advances | ||
* Trolling, insulting/derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or electronic | ||
address, without explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Our Responsibilities | ||
|
||
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. | ||
|
||
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. | ||
|
||
## Scope | ||
|
||
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. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported by contacting the project team at {{ email }}. 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. | ||
|
||
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. | ||
|
||
## Attribution | ||
|
||
> This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html) Code of Conduct. |
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,87 @@ | ||
name: 🐛 Bug Report | ||
description: File a bug report to help us improve | ||
title: "[Bug]: " | ||
labels: ["type: bug"] | ||
|
||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thank you for taking the time to fill out this bug report! | ||
- type: textarea | ||
id: what-happened | ||
attributes: | ||
label: What happened? | ||
placeholder: Tell us what you see! | ||
value: "A bug happened!" | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: ExpectedBehavior | ||
attributes: | ||
label: Expected behavior? | ||
placeholder: Tell us what you see! | ||
value: "A bug shouldn't have happened!" | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: PossibleSolution | ||
attributes: | ||
label: Possible Solution? | ||
validations: | ||
required: false | ||
- type: dropdown | ||
id: PowerShellVersion | ||
attributes: | ||
label: PowerShell Version | ||
description: What version of PowerShell are you running? | ||
options: | ||
- 5.1 - (PowerShell) | ||
- 7.2.x - (PowerShell Core) | ||
- 7.3.x - (PowerShell Core) | ||
- 7.4.x - (PowerShell Core) | ||
- type: dropdown | ||
id: OperatingSystem | ||
attributes: | ||
label: What operating system are you seeing the problem on? | ||
multiple: true | ||
options: | ||
- Windows | ||
- Linux - Ubuntu\Debian | ||
- Linux - CentOS\RedHat\Fedora | ||
- Linux - openSUSE | ||
- macOS | ||
- type: textarea | ||
id: logs | ||
attributes: | ||
label: Relevant log output | ||
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. | ||
render: PowerShell | ||
- type: textarea | ||
id: HelpCommands | ||
attributes: | ||
label: Help Commands | ||
description: Please share additional details about your environment. | ||
value: "$PSversionTable | ||
|
||
Get-Package -Name ITGlueAPI | Select-Object Name,Version,Source,ProviderName | ||
|
||
Get-ComputerInfo -Property @( | ||
'OsName', | ||
'OsVersion', | ||
'OsOperatingSystemSKU', | ||
'OSArchitecture', | ||
'WindowsVersion', | ||
'WindowsBuildLabEx', | ||
'OsLanguage', | ||
'OsMuiLanguages' | ||
)" | ||
render: PowerShell | ||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: Code of Conduct | ||
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/itglue/powershellwrapper/blob/master/.github/CODE_OF_CONDUCT.md) | ||
options: | ||
- label: I agree to follow this project's Code of Conduct | ||
required: true |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
blank_issues_enabled: true | ||
contact_links: | ||
- name: Project Documentation | ||
url: https://itglue.github.io/ITGlue-PowerShellWrapper/ | ||
about: Read through the generated documentation | ||
- name: Vendor Documentation | ||
url: https://api.itglue.com/developer | ||
about: Read through the vendors documentation |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
name: 📝 Documentation Request | ||
description: Suggest extra documentation for this project | ||
title: "[Documentation Request]: " | ||
labels: ["type: documentation"] | ||
|
||
body: | ||
- type: checkboxes | ||
id: ReadME | ||
attributes: | ||
label: Project README | ||
description: "[Project README](https://github.com/itglue/powershellwrapper/blob/master/README.md)" | ||
options: | ||
- label: "Have you read the projects README?" | ||
- type: checkboxes | ||
id: WebDocumentation | ||
attributes: | ||
label: Online Documentation | ||
description: "[Online Documentation](https://itglue.github.io/ITGlue-PowerShellWrapper/)" | ||
options: | ||
- label: "Have you read the online documentation" | ||
- type: checkboxes | ||
id: PowerShellHelp | ||
attributes: | ||
label: PowerShell Help | ||
description: "Get-Help Get-ITGlue<RESOURCES-NAME> -Full" | ||
options: | ||
- label: "Have you read the help output?" | ||
- type: textarea | ||
id: DocumentationRequest | ||
attributes: | ||
label: Documentation Request | ||
description: What would you like to see more documentation around? | ||
render: Text | ||
- type: textarea | ||
id: ExistingIssue | ||
attributes: | ||
label: Existing Issue? | ||
description: Is this related to an existing issue? If so please describe or link. | ||
value: "Issue: #12345" |
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
name: 🚀 Feature Request | ||
description: Suggest a new feature for this project | ||
title: "[Feature Request]: " | ||
labels: ["type: feature request"] | ||
|
||
body: | ||
- type: checkboxes | ||
id: ReadME | ||
attributes: | ||
label: Project README | ||
description: "[Project README](https://github.com/itglue/powershellwrapper/blob/master/README.md)" | ||
options: | ||
- label: "Have you read the projects README?" | ||
- type: checkboxes | ||
id: WebDocumentation | ||
attributes: | ||
label: Online Documentation | ||
description: "[Online Documentation](https://itglue.github.io/ITGlue-PowerShellWrapper/)" | ||
options: | ||
- label: "Have you read the online documentation" | ||
- type: checkboxes | ||
id: PowerShellHelp | ||
attributes: | ||
label: PowerShell Help | ||
description: "Get-Help Get-ITGlue<RESOURCES-NAME> -Full" | ||
options: | ||
- label: "Have you read the help output?" | ||
- type: textarea | ||
id: NewFeature | ||
attributes: | ||
label: Describe the solution you'd like | ||
description: A clear and concise description of what you want to happen. | ||
render: Text | ||
- type: textarea | ||
id: NewFeatureAlternatives | ||
attributes: | ||
label: Describe alternatives you've considered | ||
description: A clear and concise description of any alternative solutions or features you've considered. | ||
render: Text | ||
- type: textarea | ||
id: ExistingIssue | ||
attributes: | ||
label: Existing Issue? | ||
description: Is this related to an existing issue? If so please describe or link. | ||
value: "Issue: #12345" |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
name: 👋 Help Request | ||
description: What can the community help with | ||
title: "[Help Request]: " | ||
labels: ["help wanted"] | ||
|
||
body: | ||
- type: checkboxes | ||
id: ReadME | ||
attributes: | ||
label: Project README | ||
description: "[Project README](https://github.com/itglue/powershellwrapper/blob/master/README.md)" | ||
options: | ||
- label: "Have you read the projects README?" | ||
- type: checkboxes | ||
id: WebDocumentation | ||
attributes: | ||
label: Online Documentation | ||
description: "[Online Documentation](https://itglue.github.io/ITGlue-PowerShellWrapper/)" | ||
options: | ||
- label: "Have you read the online documentation" | ||
- type: checkboxes | ||
id: PowerShellHelp | ||
attributes: | ||
label: PowerShell Help | ||
description: "Get-Help Get-ITGlue<RESOURCES-NAME> -Full" | ||
options: | ||
- label: "Have you read the help output?" | ||
- type: textarea | ||
id: HelpRequest | ||
attributes: | ||
label: Help Request | ||
description: What would you like help with? | ||
render: Text | ||
- type: textarea | ||
id: ExistingIssue | ||
attributes: | ||
label: Existing Issue? | ||
description: Is this related to an existing issue? If so please describe or link. | ||
value: "Issue: #12345" |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# Responsible Security Disclosure README standard | ||
|
||
## Our security policy and Your responsibility | ||
|
||
- **POLICY**: | ||
|
||
*Our security policy is to avoid leaving the ecosystem worse than we found it. Meaning we are not planning to introduce vulnerabilities into the ecosystem.* | ||
|
||
The "ITGlueAPI" team and community take all security bugs in "ITGlueAPI" seriously. Thank you for improving the security of "ITGlueAPI". We appreciate your efforts and responsible disclosure and will make every effort to acknowledge your contributions. | ||
|
||
Report security bugs by emailing the lead maintainer at [[email protected]]([email protected]) and include the word "SECURITY" in the subject line.. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Another email address placeholder and bonus period at end of line There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. oops, that'll be an easy fix, and ya another placeholder from a canned security readme |
||
|
||
The lead maintainer will acknowledge your email within a week, and will send a more detailed response 48 hours after that indicating the next steps in handling your report. After the initial reply to your report, the security team will endeavor to keep you informed of the progress towards a fix and full announcement, and may ask for additional information or guidance. | ||
Celerium marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- "ITGlueAPI" will confirm the problem and determine the affected versions. | ||
- "ITGlueAPI" will audit code to find any potential similar problems. | ||
- "ITGlueAPI" will prepare fixes for all releases still under maintenance. These fixes will be released as fast as possible. | ||
|
||
Report security bugs in third-party modules to the person or team maintaining the module. | ||
|
||
- **SECURITY DISCLOSURE**: | ||
|
||
*Your responsibility is to report vulnerabilities to us using the guidelines outlined below.* | ||
|
||
Discuss how someone should disclose a vulnerability to "ITGlueAPI", in tl;dr ( or ELI5 ) language. Then expand on this with "How To Disclose a vulnerability in detail". Please give detailed steps on how to disclose the vulnerability. Keep these OWASP guidelines in mind ( <https://www.owasp.org/index.php/Vulnerability_Disclosure_Cheat_Sheet> ) when creating your disclosure policy. Below are some recommendations for security disclosures: | ||
|
||
- "ITGlueAPI" security contact { [[email protected]]([email protected]) } | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Another email address placeholder for consideration |
||
- Disclosure format: When disclosing vulnerabilities please | ||
1. Your name and affiliation (if any). | ||
2. include scope of vulnerability. Let us know who could use this exploit. | ||
3. document steps to identify the vulnerability. It is important that we can reproduce your findings. | ||
4. how to exploit vulnerability, give us an attack scenario. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like an email address is desired here, thoughts?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ya there are a few placeholder items throughout this commit that I couldn't populate as I didn't know if this proposed change would be accepted plus what item to use in its place.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK. Just noting them for now.