Skip to content

Commit 3910973

Browse files
authored
Add design doc and PR template (#329)
* Add design doc and pr request template * Address comments and discussion points.
1 parent dcdb71c commit 3910973

File tree

3 files changed

+398
-0
lines changed

3 files changed

+398
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
<!-- Anything that looks like this is a comment and can't be seen after the Pull Request is created. -->
2+
3+
# PR Summary
4+
5+
<!-- Summarize your PR between here and the checklist. -->
6+
7+
## PR Context
8+
9+
<!-- Provide a little reasoning as to why this Pull Request helps and why you have opened it. -->
10+
11+
## PR Checklist
12+
13+
- [ ] [PR has a meaningful title](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission)
14+
- Use the present tense and imperative mood when describing your changes
15+
- [ ] [Summarized changes](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission)
16+
- [ ] [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)
17+
- [ ] 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).
18+
- 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.
19+
- **[Breaking changes](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#making-breaking-changes)**
20+
- [ ] None
21+
- **OR**
22+
- [ ] [Documentation needed]()
23+
- [ ] Issue filed: <!-- Number/link of that issue here -->
24+
- **User-facing changes**
25+
- [ ] Not Applicable
26+
- **OR**
27+
- [ ] [Documentation needed]()
28+
- [ ] Issue filed: <!-- Number/link of that issue here -->
29+
- **Testing - New and feature**
30+
- [ ] N/A or can only be tested interactively
31+
- **OR**
32+
- [ ] [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)
33+
- **Tooling**
34+
- [ ] I have considered the user experience from a tooling perspective and don't believe tooling will be impacted.
35+
- **OR**
36+
- [ ] I have considered the user experience from a tooling perspective and enumerated concerns in the summary.

Docs/DesignDoc.md

+74
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# PowerShellGet V3 Module Design
2+
3+
## Description
4+
5+
PowerShellGet V3 is an upgrade to the currently available V2 module.
6+
The V2 module is completely script based, and has dependencies on other PowerShell modules(PackageManagement).
7+
8+
This version directly uses NuGet APIs, via NuGet managed code binaries.
9+
10+
For more information, see [Re-architecting PowerShellGet - the PowerShell package manager](https://github.com/PowerShell/PowerShell-RFC/pull/185).
11+
12+
## Goals
13+
14+
- Works side by side with current PowerShellGet V2 module
15+
16+
- Remove dependency on PackageManagement module, and directly use NuGet APIs
17+
18+
- Leverage the latest NuGet V3 APIs
19+
20+
- Provide cmdlets that perform similar functions but do not interfere with V2 cmdlets
21+
22+
- Implement as binary cmdlets and minimize use of PowerShell scripts
23+
24+
- Remove unneeded components (DscResources). TODO: Discuss with Sydney and Steve.
25+
26+
- Minimize binary dependencies
27+
28+
- Work over all PowerShell supported platforms
29+
30+
- Minimize code duplication
31+
32+
- Have only one .NET dependency (netstandard2.0) for Windows 5.x compatibility
33+
34+
## Compatibility Module
35+
36+
### Update module as needed
37+
38+
### Write/update tests as needed
39+
40+
## Summary of work estimates
41+
42+
### Cmdlet work estimates
43+
44+
TODO:
45+
46+
### Compatibility Module work estimates
47+
48+
TODO:
49+
50+
## Cmdlets
51+
52+
### Find-PSResource
53+
54+
[Find-PSResource](./FindPSResource.md)
55+
56+
### Get-PSResource
57+
58+
### Get-PSResourceRepository
59+
60+
### Install-PSResource
61+
62+
### Publish-PSResource
63+
64+
### Register-PSResourceRepository
65+
66+
### Save-PSResource
67+
68+
### Set-PSResourceRepository
69+
70+
### Uninstall-PSResource
71+
72+
### Unregister-PSResourceRepository
73+
74+
### Update-PSResource

0 commit comments

Comments
 (0)