.config/tsaoptions.json

@@ -0,0 +1,9 @@
+{
+    "instanceUrl": "https://msazure.visualstudio.com",
+    "projectName": "One",
+    "areaPath": "One\\MGMT\\Compute\\Powershell\\Powershell\\PowerShell Core",
+    "notificationAliases": [
+        "dongbow@microsoft.com",
+        "slee@microsoft.com"
+    ]
+}

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,10 @@
+# Microsoft Open Source Code of Conduct
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+
+Resources:
+
+- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)
+- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
+- Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns
+- Employees can reach out at [aka.ms/opensource/moderation-support](https://aka.ms/opensource/moderation-support)

.github/CONTRIBUTING.md

@@ -0,0 +1,115 @@
+# Contributing to PSReadLine
+
+We welcome and appreciate contributions from the community.
+There are many ways to become involved with PSReadLine, including
+
+- Filing issues
+- Joining in design conversations
+- Writing and improving documentation
+- Contributing to the code
+
+Please read the rest of this document to ensure a smooth contribution process.
+
+## Intro to Git and GitHub
+
+* Make sure you have a [GitHub account](https://github.com/signup/free).
+* Learning Git:
+    * GitHub Help: [Good Resources for Learning Git and GitHub][good-git-resources]
+    * [Git Basics][git-basics]: install and getting started
+* [GitHub Flow Guide](https://guides.github.com/introduction/flow/):
+  step-by-step instructions of GitHub Flow
+
+## Contributor License Agreement (CLA)
+
+To speed up the acceptance of any contribution to any PowerShell repositories,
+you should sign the [Microsoft Contributor License Agreement (CLA)][cla] ahead of time.
+If you've already contributed to PowerShell or Microsoft repositories in the past, congratulations!
+You've already completed this step.
+This a one-time requirement for the PowerShell projects.
+Signing the CLA process is simple and can be done in less than a minute.
+You don't have to do this up-front.
+You can simply clone, fork, and submit your pull request as usual.
+When your pull request is created, it is checked by the CLA bot.
+If you have signed the CLA, the status check will be set to `passing`.  Otherwise, it will stay at `pending`.
+Once you sign a CLA, all your existing and future pull requests will have the status check automatically set at `passing`.
+
+## Contributing to Issues
+
+* Check if the issue you are going to file already exists in our [GitHub issues][open-issue].
+* If you can't find your issue already,
+  [open a new issue](https://github.com/PowerShell/PSReadLine/issues/new/choose),
+  making sure to follow the directions as best you can.
+* If the issue is marked as [Up-for-Grabs][up-for-grabs],
+  the PSReadLine Maintainers are looking for help with the issue.
+
+## Contributing to Documentation
+
+The documentation is located in the [docs][psreadline-docs] folder.
+The markdown files there are converted to the PowerShell `help.xml` file via [platyPS][platy-ps] during the build.
+
+## Contributing to Code
+
+### Forks and Pull Requests
+
+GitHub fosters collaboration through the notion of [pull requests][using-prs].
+On GitHub, anyone can [fork][fork-a-repo] an existing repository
+into their own user account, where they can make private changes to their fork.
+To contribute these changes back into the original repository,
+a user simply creates a pull request in order to "request" that the changes be taken "upstream".
+
+Additional references:
+
+* GitHub's guide on [forking](https://guides.github.com/activities/forking/)
+* GitHub's guide on [Contributing to Open Source](https://guides.github.com/activities/contributing-to-open-source/#pull-request)
+* GitHub's guide on [Understanding the GitHub Flow](https://guides.github.com/introduction/flow/)
+
+### Bootstrap, Build and Test
+
+See the [Building](../README.md#building) section in README for details.
+
+### Submitting Pull Request
+
+* If your change would fix a security vulnerability,
+  first follow the [vulnerability issue reporting policy][vuln-reporting], before submitting a PR.
+* To avoid merge conflicts, make sure your branch is rebased on the `master` branch of this repository.
+* Many code changes will require new tests,
+  so make sure you've added a new test if existing tests do not effectively cover the code changed.
+* If your change adds a new source file, ensure the appropriate copyright and license headers is on top.
+  It is standard practice to have both a copyright and license notice for each source file.
+    * For `.cs` files use the copyright header with empty line after it:
+
+    ```c#
+        // Copyright (c) Microsoft Corporation.
+        // Licensed under the 2-Clause BSD License.
+        <Add empty line here>
+    ```
+
+    * For `.ps1` files use the copyright header with empty line after it:
+
+    ```powershell
+        # Copyright (c) Microsoft Corporation.
+        # Licensed under the 2-Clause BSD License.
+        <Add empty line here>
+    ```
+* If you're contributing in a way that changes the user or developer experience, you are expected to document those changes.
+* When you create a pull request,
+  use a meaningful title for the PR describing what change you want to check in.
+  Make sure you also include a summary about your changes in the PR description.
+  The description is used to create change logs,
+  so try to have the first sentence explain the benefit to end users.
+  If the changes are related to an existing GitHub issue,
+  please reference the issue in the PR description (e.g. ```Fix #11```).
+  See [this][closing-via-message] for more details.
+
+
+[up-for-grabs]: https://github.com/PowerShell/PSReadLine/issues?q=is%3Aopen+is%3Aissue+label%3AUp-for-Grabs
+[good-git-resources]: https://help.github.com/articles/good-resources-for-learning-git-and-github/
+[git-basics]: https://github.com/PowerShell/PowerShell/blob/master/docs/git/basics.md
+[cla]: https://cla.microsoft.com/
+[open-issue]: https://github.com/PowerShell/PSReadLine/issues
+[psreadline-docs]: https://github.com/PowerShell/PSReadLine/tree/master/docs
+[platy-ps]: https://www.powershellgallery.com/packages/platyPS
+[using-prs]: https://help.github.com/articles/using-pull-requests/
+[fork-a-repo]: https://help.github.com/articles/fork-a-repo/
+[vuln-reporting]: SECURITY.md
+[closing-via-message]: https://help.github.com/articles/closing-issues-via-commit-messages/

.github/ISSUE_TEMPLATE.md → .github/ISSUE_TEMPLATE/Bug_Report.md

@@ -1,19 +1,35 @@
+---
+name: "Bug report 🐛"
+about: Report errors or unexpected behaviors 🤔
+title: ''
+labels: ''
+assignees: ''
+
+---
+
 <!--
-Before submitting your bug report, please check for duplicates, and +1 the duplicate if you find one, adding additional details if you have any to add.
 
-There are a few common issues that are commonly reported.
+Before submitting your bug report ...
+- Please make sure you are able to reproduce the issue with the latest version of PSReadLine.
+- Please check for duplicates. +1 the duplicate if you find one and add additional details if you have any.
+
+The maintainer may close your issue without further explanation or engagement if:
+- You delete this entire template and go your own path;
+- You file an issue that has many duplicates;
+- You file an issue completely blank in the body.
 
-If there is an exception copying to/from the clipboard, it's probably the same as https://github.com/PowerShell/PSReadLine/issues/265
-If there is an exception shortly after resizing the console, it's probably the same as https://github.com/PowerShell/PSReadLine/issues/292
 -->
 
-Environment data
-----------------
+## Environment
+
+```none
+[run the script below and paste the output here]
+```
 
 <!--
 
 The following script will generate the environment data that helps triage and investigate the issue.
-Please run the script in the PowerShell session where you ran into the issue and provide the output here.
+Please run the script in the PowerShell session where you ran into the issue and provide the output above.
 
 & {
     $hostName = $Host.Name
@@ -30,11 +46,9 @@ Please run the script in the PowerShell session where you ran into the issue and
     }
 
     "`nPS version: $($PSVersionTable.PSVersion)"
-    $v = (Get-Module PSReadline).Version
-    $m = Get-Content "$(Split-Path -Parent (Get-Module PSReadLine).Path)\PSReadLine.psd1" | Select-String "Prerelease = '(.*)'"
-    if ($m) {
-        $v = "$v-" + $m.Matches[0].Groups[1].Value
-    }
+    $m = Get-Module PSReadline
+    $v = $m.Version; $pre = $m.PrivateData.PSData.Prerelease
+    if ($pre) { $v = "$v-$pre" }
     "PSReadline version: $v"
     if ($IsLinux -or $IsMacOS) {
         "os: $(uname -a)"
@@ -49,5 +63,18 @@ Please run the script in the PowerShell session where you ran into the issue and
 
 -->
 
-Steps to reproduce or exception report
---------------------------------------
+## Exception report
+
+<!-- Copy and paste the keys and the exception stack trace printed by PSReadLine, if there is any -->
+
+## Steps to reproduce
+
+<!-- A description of how to trigger this bug. -->
+
+## Expected behavior
+
+<!-- A description of what you're expecting, possibly containing screenshots or reference material. -->
+
+## Actual behavior
+
+<!-- What's actually happening? -->

.github/ISSUE_TEMPLATE/Bug_Report.yaml

@@ -0,0 +1,102 @@
+name: Bug report 🐛
+description: Report errors or unexpected behavior 🤔
+labels: Needs-Triage
+body:
+- type: checkboxes
+  attributes:
+    label: Prerequisites
+    options:
+    - label: Write a descriptive title.
+      required: true
+    - label: Make sure you are able to repro it on the [latest released version](https://www.powershellgallery.com/packages/PSReadLine)
+      required: true
+    - label: Search the existing issues, especially the pinned issues.
+      required: true
+- type: textarea
+  attributes:
+    label: Exception report
+    description: |
+      Copy and paste the **COMPLETE** exception report message generated by PSReadLine.
+      If no exception report was involved, simply put "N/A" below.
+    render: console
+    placeholder: Oops, something went wrong ...
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Screenshot
+    description: |
+      - In case of an exception, **DO NOT take screenshot of the exception report**!
+        Instead, please scroll up to above the exception report, and take a screenshot of the console state right before the exception happened.
+        Also, please keep your terminal window size unchanged when taking screenshot.
+      - If no exception was involved, please upload images or animations that you think may be helpful, or put "N/A" below.
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Environment data
+    description: |
+      The following script will generate the environment data that helps triage and investigate the issue.
+      Please run the script in the PowerShell session where you ran into the issue, and paste the verbatim output below.
+      ```powershell
+      & {
+          $hostName = $Host.Name
+          if ($hostName -eq "ConsoleHost" -and (Get-Command Get-CimInstance -ErrorAction SilentlyContinue)) {
+              $id = $PID; $inWindowsTerminal = $false
+              while ($true) {
+                  $p = Get-CimInstance -ClassName Win32_Process -Filter "ProcessId Like $id"
+                  if (!$p -or !$p.Name) { break }
+                  if ($p.Name -eq "WindowsTerminal.exe") { $inWindowsTerminal = $true; break }
+                  $id = $p.ParentProcessId
+              }
+              if ($inWindowsTerminal) { $hostName += " (Windows Terminal)" }
+          }
+
+          $m = Get-Module PSReadline
+          $v = $m.Version; $pre = $m.PrivateData.PSData.Prerelease
+          if ($pre) { $v = "$v-$pre" }
+          $os = if ($IsLinux -or $IsMacOS) { uname -a } else { (dir $env:SystemRoot\System32\cmd.exe).VersionInfo.FileVersion }
+
+          Write-Host ''
+          Write-Host "PS Version: $($PSVersionTable.PSVersion)"
+          Write-Host "PS HostName: $hostName"
+          Write-Host "PSReadLine Version: $v"
+          Write-Host "PSReadLine EditMode: $((Get-PSReadLineOption).EditMode)"
+          Write-Host "OS: $os"
+          Write-Host "BufferWidth: $([console]::BufferWidth)"
+          Write-Host "BufferHeight: $([console]::BufferHeight)"
+          Write-Host ''
+      }
+      ```
+    render: console
+    placeholder: |
+      PS Version: ...
+      PS HostName: ...
+      PSReadLine Version: ...
+      PSReadLine EditMode: ...
+      OS: ...
+      BufferWidth: ...
+      BufferHeight: ...
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Steps to reproduce
+    description: |
+      List of steps or sample code to reproduce the issue.
+    placeholder: |
+      A description of how to trigger the issue.
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Expected behavior
+    placeholder: No exception ...
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Actual behavior
+    placeholder: The above exception happens ...
+  validations:
+    required: true

.github/ISSUE_TEMPLATE/Documentation_Issue.yaml

@@ -0,0 +1,15 @@
+name: Documentation Issue 📚
+description: Report documentation issues at https://github.com/MicrosoftDocs/PowerShell-Docs/issues/new/choose
+labels: Issue-Docs
+body:
+- type: markdown
+  attributes:
+    value: |
+      Thanks for taking the time to fill out this documentation Issue!
+      Documents for PSReadLine are hosted in the [PowerShell-Docs](https://github.com/MicrosoftDocs/PowerShell-Docs) repo. So, please submit the issue directly in that repo for a quicker response and fix.
+- type: checkboxes
+  attributes:
+    label: Prerequisites
+    options:
+    - label: Write a descriptive title.
+      required: true

.github/ISSUE_TEMPLATE/Feature_Request.yaml

@@ -0,0 +1,23 @@
+name: Feature Request or Idea 🚀
+description: Suggest a new feature or improvement.
+labels: Issue-Enhancement
+body:
+- type: checkboxes
+  attributes:
+    label: Prerequisites
+    options:
+    - label: Write a descriptive title.
+      required: true
+- type: textarea
+  attributes:
+    label: Description of the new feature/enhancement
+    description: |
+      A clear and concise description of what the problem is that the new feature would solve.
+      Describe why and how a user would use this new functionality (if applicable).
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Proposed technical implementation details (optional)
+    description: |
+      A clear and concise description of how you want it to happen.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,18 @@
+<!-- Anything that looks like this is a comment and can't be seen after the Pull Request is created. -->
+
+# PR Summary
+
+<!-- Summarize your PR between here and the checklist. -->
+
+## PR Checklist
+
+- [ ] PR has a meaningful title
+    - Use the present tense and imperative mood when describing your changes
+- [ ] Summarized changes
+- [ ] Make sure you've added one or more new tests
+- [ ] Make sure you've tested these changes in terminals that PowerShell is commonly used in (i.e. conhost.exe, Windows Terminal, Visual Studio Code Integrated Terminal, etc.)
+- **User-facing changes**
+    - [ ] Not Applicable
+    - **OR**
+    - [ ] Documentation needed at [PowerShell-Docs](https://github.com/MicrosoftDocs/PowerShell-Docs)
+        - [ ] Doc Issue filed: <!-- Number/link of that issue here -->