Skip to content
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

Add design doc and PR template #329

Merged
merged 2 commits into from
Jan 16, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<!-- 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 Context

<!-- Provide a little reasoning as to why this Pull Request helps and why you have opened it. -->

## PR Checklist

- [ ] [PR has a meaningful title](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission)
- Use the present tense and imperative mood when describing your changes
- [ ] [Summarized changes](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission)
- [ ] [Make sure all `.h`, `.cpp`, `.cs`, `.ps1` and `.psm1` files have the correct copyright header](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission)
- [ ] This PR is ready to merge and is not [Work in Progress](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---work-in-progress).
- If the PR is work in progress, please add the prefix `WIP:` or `[ WIP ]` to the beginning of the title (the `WIP` bot will keep its status check at `Pending` while the prefix is present) and remove the prefix when the PR is ready.
- **[Breaking changes](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#making-breaking-changes)**
- [ ] None
- **OR**
- [ ] [Documentation needed]()
- [ ] Issue filed: <!-- Number/link of that issue here -->
- **User-facing changes**
- [ ] Not Applicable
- **OR**
- [ ] [Documentation needed]()
- [ ] Issue filed: <!-- Number/link of that issue here -->
- **Testing - New and feature**
- [ ] N/A or can only be tested interactively
- **OR**
- [ ] [Make sure you've added a new test if existing tests do not effectively test the code changed](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#before-submitting)
- **Tooling**
- [ ] I have considered the user experience from a tooling perspective and don't believe tooling will be impacted.
- **OR**
- [ ] I have considered the user experience from a tooling perspective and enumerated concerns in the summary.
74 changes: 74 additions & 0 deletions Docs/DesignDoc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# PowerShellGet V3 Module Design

## Description

PowerShellGet V3 is an upgrade to the currently available V2 module.
The V2 module is completely script based, and has dependencies on other PowerShell modules(PackageManagement).

This version directly uses NuGet APIs, via NuGet managed code binaries.

For more information, see [Re-architecting PowerShellGet - the PowerShell package manager](https://github.com/PowerShell/PowerShell-RFC/pull/185).

## Goals

- Works side by side with current PowerShellGet V2 module

- Remove dependency on PackageManagement module, and directly use NuGet APIs

- Leverage the latest NuGet V3 APIs

- Provide cmdlets that perform similar functions but do not interfere with V2 cmdlets

- Implement as binary cmdlets and minimize use of PowerShell scripts

- Remove unneeded components (DscResources). TODO: Discuss with Sydney and Steve.

- Minimize binary dependencies

- Work over all PowerShell supported platforms

- Minimize code duplication

- Have only one .NET dependency (netstandard2.0) for Windows 5.x compatibility

## Compatibility Module

### Update module as needed

### Write/update tests as needed

## Summary of work estimates

### Cmdlet work estimates

TODO:

### Compatibility Module work estimates

TODO:

## Cmdlets

### Find-PSResource

[Find-PSResource](./FindPSResource.md)

### Get-PSResource

### Get-PSResourceRepository

### Install-PSResource

### Publish-PSResource

### Register-PSResourceRepository

### Save-PSResource

### Set-PSResourceRepository

### Uninstall-PSResource

### Unregister-PSResourceRepository

### Update-PSResource
Loading