Skip to content

Commit c418c4f

Browse files
authored
Adding pr template and readme update with samples (#247)
Co-authored-by: Nikola Metulev <711864+nmetulev@users.noreply.github.com>
1 parent b495edf commit c418c4f

File tree

3 files changed

+62
-10
lines changed

3 files changed

+62
-10
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
## Description
2+
3+
<!-- Provide a brief description of the changes in this PR -->
4+
5+
## Related Issue
6+
7+
<!-- Link to any related issues: Fixes #123, Closes #456, Related to #789 -->
8+
9+
## Type of Change
10+
11+
<!-- Mark the appropriate option(s) with an "x" -->
12+
13+
- [ ] 🐛 Bug fix (non-breaking change that fixes an issue)
14+
- [ ] ✨ New feature (non-breaking change that adds functionality)
15+
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to change)
16+
- [ ] 📝 Documentation update
17+
- [ ] 🔧 Configuration/build change
18+
- [ ] ♻️ Refactoring (no functional changes)
19+
- [ ] 🧪 Test update
20+
21+
## Checklist
22+
23+
### Build & Tests
24+
25+
- [ ] All CI builds pass (Build and Package workflow)
26+
- [ ] All existing tests pass
27+
- [ ] New tests added for new functionality (if applicable)
28+
- [ ] Tested locally on Windows
29+
30+
### README & Guides
31+
32+
<!-- Check all that apply to your changes -->
33+
34+
- [ ] Main [README.md](../README.md) updated (if applicable)
35+
- [ ] [docs/usage.md](../docs/usage.md) updated (if CLI commands changed)
36+
- [ ] [Language-specific guides](../docs/guides) updated (if applicable)
37+
- [ ] [Sample projects updated](../samples) to reflect changes (if applicable)
38+
- [ ] No documentation updates needed
39+
40+
## Screenshots / Demo
41+
42+
<!-- If applicable, add screenshots or GIFs demonstrating the changes -->
43+
44+
## Additional Notes
45+
46+
<!-- Any additional information that reviewers should know -->
47+

README.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
1-
# Windows App Development CLI
1+
# winapp CLI
22

33
> [!IMPORTANT]
4-
> :warning: **Status: Public Preview** - The Windows App Development CLI is experimental and in active development. We'd love your feedback! Share your thoughts by creating an [issue](https://github.com/microsoft/WinAppCli/issues).
4+
> :warning: **Status: Public Preview** - The Windows App Development CLI (winapp CLI) is experimental and in active development. We'd love your feedback! Share your thoughts by creating an [issue](https://github.com/microsoft/WinAppCli/issues).
55
66
<p align="center">
77
<picture>
8-
<source media="(prefers-color-scheme: dark)" srcset="./docs/images/hero-dark.png">
9-
<source media="(prefers-color-scheme: light)" srcset="./docs/images/hero-light.png">
10-
<img src="./docs/images/hero-dark.png">
8+
<img src="./docs/images/winapp-terminal.png">
119
</picture>
1210
</p>
1311
<br/>
@@ -44,7 +42,7 @@
4442
</h3>
4543
<br/>
4644

47-
The Windows App Development CLI is a single command-line interface for managing Windows SDKs, packaging, generating app identity, manifests, certificates, and using build tools with any app framework. This tool bridges the gap between cross-platform development and Windows-native capabilities.
45+
The Windows App Development CLI (winapp CLI) is a single command-line interface for managing Windows SDKs, packaging, generating app identity, manifests, certificates, and using build tools with any app framework. This tool bridges the gap between cross-platform development and Windows-native capabilities.
4846
<br/><br/>
4947
Whether you're building with Electron, .NET/Win32, CMake, or Python, this CLI gives you access to:
5048

@@ -160,10 +158,17 @@ The full CLI usage can be found here: [Documentation](/docs/usage.md)
160158

161159
## 🧾 Samples
162160

163-
This repository will continue to be added with samples. Currently the following samples exist:
164-
165-
- [Electron sample](/samples/electron/README.md): a default Electron Forge generated application + initialized a winapp project with appxmanifest, assets + native addon + C# addon + generates cert
166-
- [Electron WinML sample](/samples/electron-winml/README.md): a simple Electron application using Windows ML for classifying images
161+
This repository includes samples demonstrating how to use the CLI with various frameworks:
162+
163+
| Sample | Description |
164+
|--------|-------------|
165+
| [Electron](/samples/electron/README.md) | Electron Forge app with appxmanifest, assets, native C++ addon, and C# addon |
166+
| [Electron WinML](/samples/electron-winml/README.md) | Electron app using Windows ML for image classification |
167+
| [C++ App](/samples/cpp-app/README.md) | Native C++ Win32 application with CMake |
168+
| [.NET Console](/samples/dotnet-app/README.md) | .NET console application |
169+
| [WPF App](/samples/wpf-app/README.md) | WPF desktop application |
170+
| [Rust App](/samples/rust-app/README.md) | Rust application using Windows APIs |
171+
| [Tauri App](/samples/tauri-app/README.md) | Tauri cross-platform app with Rust backend |
167172

168173
## 🔧 Feedback
169174

docs/images/winapp-terminal.png

166 KB
Loading

0 commit comments

Comments
 (0)