Skip to content

Commit bc4e261

Browse files
committed
Update Code of Conduct and Security Policy
Updates the readme, code of conduct and security policy per OSPO request. Also auto-fix Markdown issues and list Tig as a maintainer.
1 parent a3160af commit bc4e261

File tree

4 files changed

+65
-34
lines changed

4 files changed

+65
-34
lines changed

.github/CODE_OF_CONDUCT.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Microsoft Open Source Code of Conduct
2+
3+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
4+
5+
Resources:
6+
7+
- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)
8+
- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
9+
- Contact [[email protected]](mailto:[email protected]) with questions or concerns
10+
- Employees can reach out at [aka.ms/opensource/moderation-support](https://aka.ms/opensource/moderation-support)

.github/SECURITY.md

+38-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,41 @@
1-
# Security Vulnerabilities
1+
<!-- BEGIN MICROSOFT SECURITY.MD V0.0.9 BLOCK -->
22

3-
Security issues are treated very seriously and will, by default,
4-
takes precedence over other considerations including usability, performance,
5-
etc... Best effort will be used to mitigate side effects of a security
6-
change, but PowerShell must be secure by default.
3+
## Security
74

8-
## Reporting a security vulnerability
5+
Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin) and [PowerShell](https://github.com/PowerShell).
96

10-
If you believe that there is a security vulnerability in PowerShell,
11-
it **must** be reported to [[email protected]](https://technet.microsoft.com/security/ff852094.aspx) to allow for [Coordinated Vulnerability Disclosure](https://technet.microsoft.com/security/dn467923).
12-
**Only** file an issue, if [[email protected]](https://www.microsoft.com/en-us/msrc/faqs-report-an-issue?rtc=1) has confirmed filing an issue is appropriate.
7+
If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://aka.ms/security.md/definition), please report it to us as described below.
8+
9+
## Reporting Security Issues
10+
11+
**Please do not report security vulnerabilities through public GitHub issues.**
12+
13+
Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://aka.ms/security.md/msrc/create-report).
14+
15+
If you prefer to submit without logging in, send email to [[email protected]](mailto:[email protected]). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://aka.ms/security.md/msrc/pgp).
16+
17+
You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc).
18+
19+
Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
20+
21+
* Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
22+
* Full paths of source file(s) related to the manifestation of the issue
23+
* The location of the affected source code (tag/branch/commit or direct URL)
24+
* Any special configuration required to reproduce the issue
25+
* Step-by-step instructions to reproduce the issue
26+
* Proof-of-concept or exploit code (if possible)
27+
* Impact of the issue, including how an attacker might exploit the issue
28+
29+
This information will help us triage your report more quickly.
30+
31+
If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://aka.ms/security.md/msrc/bounty) page for more details about our active programs.
32+
33+
## Preferred Languages
34+
35+
We prefer all communications to be in English.
36+
37+
## Policy
38+
39+
Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://aka.ms/security.md/cvd).
40+
41+
<!-- END MICROSOFT SECURITY.MD BLOCK -->

CODE_OF_CONDUCT.md

-8
This file was deleted.

README.md

+17-17
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# ConsoleGuiTools - `Out-ConsoleGridView` and `Show-ObjectTree`
22

3-
This repo contains the `Out-ConsoleGridView`
3+
This repo contains the `Out-ConsoleGridView`
44
PowerShell Cmdlet providing console-based GUI experiences based on
55
[Terminal.Gui (gui.cs)](https://github.com/gui-cs/Terminal.Gui).
66

@@ -94,17 +94,18 @@ Get-Process -ComputerName "Server01" | ocgv -Title "Processes - Server01"
9494

9595
This command displays the processes that are running on the Server01 computer in a grid view window.
9696

97-
The command uses `ocgv`, which is the built-in alias for the **Out-ConsoleGridView** cmdlet, it uses the *Title* parameter to specify the window title.
97+
The command uses `ocgv`, which is the built-in alias for the **Out-ConsoleGridView** cmdlet, it uses the _Title_ parameter to specify the window title.
9898

9999
### Example 6: Define a function to kill processes using a graphical chooser
100100

101101
```PowerShell
102102
function killp { Get-Process | Out-ConsoleGridView -OutputMode Single -Filter $args[0] | Stop-Process -Id {$_.Id} }
103103
killp note
104104
```
105+
105106
This example shows defining a function named `killp` that shows a grid view of all running processes and allows the user to select one to kill it.
106107

107-
The example uses the `-Filter` paramter to filter for all proceses with a name that includes `note` (thus highlighting `Notepad` if it were running. Selecting an item in the grid view and pressing `ENTER` will kill that process.
108+
The example uses the `-Filter` paramter to filter for all proceses with a name that includes `note` (thus highlighting `Notepad` if it were running. Selecting an item in the grid view and pressing `ENTER` will kill that process.
108109

109110
### Example 7: Pass multiple items through Out-ConsoleGridView
110111

@@ -115,8 +116,8 @@ Get-Process | Out-ConsoleGridView -PassThru | Export-Csv -Path .\ProcessLog.csv
115116
This command lets you select multiple processes from the **Out-ConsoleGridView** window.
116117
The processes that you select are passed to the **Export-Csv** command and written to the ProcessLog.csv file.
117118

118-
The command uses the *PassThru* parameter of **Out-ConsoleGridView**, which lets you send multiple items down the pipeline.
119-
The *PassThru* parameter is equivalent to using the Multiple value of the *OutputMode* parameter.
119+
The command uses the _PassThru_ parameter of **Out-ConsoleGridView**, which lets you send multiple items down the pipeline.
120+
The _PassThru_ parameter is equivalent to using the Multiple value of the _OutputMode_ parameter.
120121

121122
### Example 8: Use F7 as "Show Command History"
122123

@@ -126,7 +127,7 @@ Press `F7` to see the history for the current PowerShell instance
126127

127128
Press `Shift-F7` to see the history for all PowerShell instances.
128129

129-
Whatever you select within `Out-ConsoleGridView` will be inserted on your command line.
130+
Whatever you select within `Out-ConsoleGridView` will be inserted on your command line.
130131

131132
Whatever was typed on the command line prior to hitting `F7` or `Shift-F7` will be used as a filter.
132133

@@ -214,27 +215,26 @@ to learn more.
214215

215216
`ConsoleGuiTools` consists of 2 .NET Projects:
216217

217-
- ConsoleGuiTools - Cmdlet implementation for Out-ConsoleGridView
218-
- OutGridView.Models - Contains data contracts between the GUI & Cmdlet
218+
* ConsoleGuiTools - Cmdlet implementation for Out-ConsoleGridView
219+
* OutGridView.Models - Contains data contracts between the GUI & Cmdlet
219220

220221
_Note:_ Previously, this repo included `Microsoft.PowerShell.GraphicalTools` which included the Avalonia-based `Out-GridView` (implemented in `.\Microsoft.PowerShell.GraphicalTools` and `.\OutGridView.Gui`). These components have been deprecated (see note above).
221222

222223
## Maintainers
223224

224-
- [Andy Jordan](https://andyleejordan.com) - [@andyleejordan](https://github.com/andyleejordan)
225+
* [Andy Jordan](https://andyleejordan.com) - [@andyleejordan](https://github.com/andyleejordan)
226+
* [Tig Kindel](https://www.kindel.com) - [@tig](https://github.com/tig)
225227

226228
Originally authored by [Tyler Leonhardt](http://twitter.com/tylerleonhardt).
227229

228230
## License
229231

230-
This project is [licensed under the MIT License](LICENSE).
232+
This project is [licensed under the MIT License](LICENSE.txt).
233+
234+
## Code of Conduct
231235

232-
## [Code of Conduct][conduct-md]
236+
Please see our [Code of Conduct](.github/CODE_OF_CONDUCT.md) before participating in this project.
233237

234-
This project has adopted the [Microsoft Open Source Code of Conduct][conduct-code].
235-
For more information see the [Code of Conduct FAQ][conduct-FAQ] or contact [[email protected]][conduct-email] with any additional questions or comments.
238+
## Security Policy
236239

237-
[conduct-code]: https://opensource.microsoft.com/codeofconduct/
238-
[conduct-FAQ]: https://opensource.microsoft.com/codeofconduct/faq/
239-
[conduct-email]: mailto:[email protected]
240-
[conduct-md]: https://github.com/PowerShell/ConsoleGuiTools/tree/master/CODE_OF_CONDUCT.md
240+
For any security issues, please see our [Security Policy](.github/SECURITY.md).

0 commit comments

Comments
 (0)