Skip to content
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
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @MikeChristensen
27 changes: 27 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Contributing to KitchenPC Samples

Thank you for contributing to KitchenPC. Please open an issue before starting a substantial change
so the design and scope can be discussed.

## Development workflow

1. Fork the repository and create a focused branch from `main`.
2. Make the smallest change that solves the issue.
3. Add or update tests when behavior changes.
4. Restore, build, and test before opening a pull request:

```bash
dotnet restore Samples.slnx
dotnet build Samples.slnx --configuration Release --no-restore
dotnet test Samples.slnx --configuration Release --no-build --no-restore
cd WebApp/ClientApp
npm ci
npm run build
npm run lint
npm test
```

5. Open a pull request against `main` and describe both the change and how it was tested.

Please do not include unrelated formatting or cleanup in a functional change. By contributing, you
agree that your contribution will be licensed under the repository's MIT license.
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Bug report
description: Report reproducible incorrect behavior in a sample
title: "[Bug]: "
labels:
- bug
body:
- type: markdown
attributes:
value: Thank you for helping improve the KitchenPC samples.
- type: textarea
id: description
attributes:
label: Description
description: What happened, and what did you expect instead?
validations:
required: true
- type: dropdown
id: sample
attributes:
label: Sample
options:
- React Web App
- Shopping List TUI
- Database Initializer
- Sample Data
- Repository or documentation
validations:
required: true
- type: textarea
id: reproduction
attributes:
label: Reproduction
description: Provide the smallest sequence of steps that reproduces the problem.
validations:
required: true
- type: textarea
id: environment
attributes:
label: Environment
description: Include the .NET and Node.js versions, operating system, database, and other relevant details.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Security vulnerability
url: https://github.com/KitchenPC/Samples/security/advisories/new
about: Report security vulnerabilities privately.
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Feature request
description: Propose a new sample or an improvement to an existing sample
title: "[Feature]: "
labels:
- enhancement
body:
- type: textarea
id: problem
attributes:
label: Problem
description: What developer use case should this sample or improvement demonstrate?
validations:
required: true
- type: textarea
id: proposal
attributes:
label: Proposed solution
description: Describe the application, workflow, or documentation you would like to see.
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives considered
description: Describe any workarounds or alternative designs you considered.
14 changes: 14 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
## Summary

Describe the problem and the proposed change.

## Testing

Describe the tests or manual checks you ran.

## Checklist

- [ ] The solution builds in Release mode.
- [ ] Relevant .NET and frontend tests pass.
- [ ] Behavioral changes include appropriate tests or documentation.
- [ ] The change contains no unrelated formatting or cleanup.
14 changes: 14 additions & 0 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Security Policy

## Supported versions

Security fixes are made on the latest version of the KitchenPC Samples repository.

## Reporting a vulnerability

Please do not disclose suspected vulnerabilities in a public issue. Use GitHub's private
vulnerability reporting feature on this repository, or contact `support@kitchenpc.com` if private
reporting is unavailable.

Include enough detail to reproduce and assess the issue. You should receive an acknowledgement
within seven days.