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
3 changes: 2 additions & 1 deletion .github/copilot-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ Available VS Code tasks (use via `run_task` tool):
- `.Net Format`: Verify formatting and style (must pass)
- `CSharpier Format`: Auto-format code with CSharpier
- `.Net Tool Update`: Update dotnet tools
- `.Net Outdated Upgrade`: Upgrade outdated NuGet dependencies (interactive prompt)
- `Husky.Net Run`: Run pre-commit hooks manually

## Coding Standards and Conventions
Expand Down Expand Up @@ -315,7 +316,7 @@ The project includes comprehensive `.editorconfig` settings that enforce:
3. **Before committing**:
- Run `.Net Format` task to verify compliance
- Husky hooks will run automatically
4. **Dependency updates**: Use `dotnet outdated --upgrade:prompt` regularly
4. **Dependency updates**: Run `.Net Outdated Upgrade` task (`dotnet outdated --upgrade:prompt`) regularly
5. **Testing**: Run tests via VS Code test explorer or `dotnet test`

## Reference Links
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/merge-bot-pull-request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ jobs:
merge-codegen:
name: Merge codegen pull request job
runs-on: ubuntu-latest
if: github.actor == 'github-actions[bot]' && github.event.pull_request.head.ref == 'codegen' && github.event.pull_request.head.repo.full_name == github.repository
if: github.event.pull_request.head.ref == 'codegen' && github.event.pull_request.head.repo.full_name == github.repository && contains(github.event.pull_request.labels.*.name, 'automated-codegen')
permissions:
contents: write
pull-requests: write
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/run-codegen-pull-request-task.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,4 @@ jobs:
commit-message: 'Update codegen files'
delete-branch: true
sign-commits: true
labels: automated-codegen
2 changes: 1 addition & 1 deletion .vscode/tasks.json
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@
"command": "dotnet",
"args": [
"outdated",
"--upgrade:Prompt"
"--upgrade:prompt"
],
"problemMatcher": [
"$msCompile"
Expand Down
48 changes: 24 additions & 24 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,25 @@

**ProjectTemplate** is a C# .NET template project demonstrating best practices. Developers use this as a baseline to create their own projects.

For comprehensive coding standards and detailed conventions, refer to [`.github/copilot-instructions.md`](./.github/copilot-instructions.md) and [`CODESTYLE.md`](./CODESTYLE.md).
For comprehensive coding standards and detailed conventions, refer to [`.github/copilot-instructions.md`](./.github/copilot-instructions.md) and [`CODESTYLE.md`](./CODESTYLE.md).

## Key Requirements for All Projects Derived from This Template

### Build & Quality Standards

- **Zero Warnings Policy**: All builds must complete without errors or warnings
- Use `CSharpier Format`, `.Net Format`, and `Husky.Net Run` tasks

- **Code Analysis**: Enable all .NET analyzers
- `<EnableNETAnalyzers>true</EnableNETAnalyzers>`
- `<AnalysisLevel>latest-all</AnalysisLevel>`

### Development Environment

- Target latest .NET SDK (currently .NET 10 with C# 14)
- Support Visual Studio Code (`.code-workspace`) and Visual Studio Community (`.slnx`)
- Support Linux, Windows, and macOS with correct line endings and permissions
- Use `.editorconfig` for style enforcement
### Build & Quality Standards
- **Zero Warnings Policy**: All builds must complete without errors or warnings
- Use `CSharpier Format`, `.Net Format`, and `Husky.Net Run` tasks
- **Code Analysis**: Enable all .NET analyzers
- `<EnableNETAnalyzers>true</EnableNETAnalyzers>`
- `<AnalysisLevel>latest-all</AnalysisLevel>`

### Development Environment
- Target latest .NET SDK (currently .NET 10 with C# 14)
- Support Visual Studio Code (`.code-workspace`) and Visual Studio Community (`.slnx`)
- Support Linux, Windows, and macOS with correct line endings and permissions
- Use `.editorconfig` for style enforcement

### Project Structure

Expand All @@ -37,14 +37,14 @@ For comprehensive coding standards and detailed conventions, refer to [`.github/
- Follow Arrange-Act-Assert pattern
- Test naming: `MethodName_Scenario_ExpectedBehavior()`

## Authoritative References

For detailed specifications, see:

- [`.github/copilot-instructions.md`](./.github/copilot-instructions.md) - Complete coding conventions and style guide
- [`CODESTYLE.md`](./CODESTYLE.md) - Code style and formatting rules
- [`.editorconfig`](./.editorconfig) - Automated style enforcement
- Project task definitions - `CSharpier Format`, `.Net Build`, `.Net Format`, `Husky.Net Run`
## Authoritative References
For detailed specifications, see:
- [`.github/copilot-instructions.md`](./.github/copilot-instructions.md) - Complete coding conventions and style guide
- [`CODESTYLE.md`](./CODESTYLE.md) - Code style and formatting rules
- [`.editorconfig`](./.editorconfig) - Automated style enforcement
- Project task definitions - `CSharpier Format`, `.Net Build`, `.Net Format`, `.Net Outdated Upgrade`, `Husky.Net Run`

## Quick Start for Derived Projects

Expand Down
1 change: 1 addition & 0 deletions CODESTYLE.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ Available VS Code tasks (use via `run_task` tool):
- `.Net Format`: Verify formatting and style (must pass)
- `CSharpier Format`: Auto-format code with CSharpier
- `.Net Tool Update`: Update dotnet tools
- `.Net Outdated Upgrade`: Upgrade outdated NuGet dependencies (interactive prompt)
- `Husky.Net Run`: Run pre-commit hooks manually

## Tooling and Editor
Expand Down
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -420,6 +420,9 @@ Licensed under the [MIT License][license-link]\
- `Review draft pull requests`
- Actions / General:
- `Allow GitHub Actions to create and approve pull requests`
- Labels:
- `https://github.com/ptr727/[project]/labels`
- Add `automated-codegen` label.
Comment thread
ptr727 marked this conversation as resolved.

### Template - Branching Workflow

Expand Down
Loading