|
1 | | -# PragmaticDotNetCodeRules |
| 1 | +# Pragmatic .NET Code Rules – Starter Kit |
| 2 | + |
| 3 | +> **Real material from the course — free for newsletter subscribers.** |
| 4 | +
|
| 5 | +This starter kit contains **ready defaults** taken directly from the course |
| 6 | +**Pragmatic .NET Code Rules**. |
| 7 | + |
| 8 | +It is designed to help you start (or clean up) a .NET project with: |
| 9 | +- consistent code style |
| 10 | +- centralized build rules |
| 11 | +- predictable SDK versions |
| 12 | +- a minimal CI quality gate |
| 13 | + |
| 14 | +No theory. |
| 15 | +No frameworks. |
| 16 | +Just **practical defaults that work**. |
| 17 | + |
| 18 | +--- |
| 19 | + |
| 20 | +## 📦 What’s Inside |
| 21 | + |
| 22 | +- `.editorconfig` |
| 23 | + Pragmatic, industry-default code style rules |
| 24 | + |
| 25 | +- `Directory.Build.props` |
| 26 | + Centralized build & analyzer configuration |
| 27 | + |
| 28 | +- `global.json` |
| 29 | + Pinned .NET SDK for reproducible builds |
| 30 | + |
| 31 | +- CI Quality Gate (GitHub Actions) |
| 32 | + Prevents dirty code from reaching `main` |
| 33 | + |
| 34 | +- Visual Studio Clean Code Checklist |
| 35 | + Helps you apply the rules in minutes |
| 36 | + |
| 37 | +--- |
| 38 | + |
| 39 | +## 🚀 How to Use This Kit |
| 40 | + |
| 41 | +1. Copy the files into the **root of your solution** |
| 42 | +2. Commit the changes |
| 43 | +3. Run **Code Cleanup** in Visual Studio |
| 44 | +4. Push — CI will enforce the rules automatically |
| 45 | + |
| 46 | +That’s it. |
| 47 | + |
| 48 | +⏱️ Setup time: **5–10 minutes** |
| 49 | + |
| 50 | +--- |
| 51 | + |
| 52 | +## 🎓 About the Course |
| 53 | + |
| 54 | +This starter kit is **Module 01 material** from the course: |
| 55 | + |
| 56 | +**Pragmatic .NET Code Rules** |
| 57 | + |
| 58 | +The full course covers: |
| 59 | +- advanced EditorConfig usage |
| 60 | +- automated code cleanup |
| 61 | +- diagnostic severities & warnings as errors |
| 62 | +- static code analysis (StyleCop, SonarAnalyzer) |
| 63 | +- centralized build rules |
| 64 | +- architecture tests |
| 65 | +- CI quality gates |
| 66 | +- logging & observability |
| 67 | +- AI-assisted PR & dependency reviews |
| 68 | + |
| 69 | +--- |
| 70 | + |
| 71 | +## 🔓 Free, for Now |
| 72 | + |
| 73 | +This material is currently **free for newsletter subscribers**. |
| 74 | + |
| 75 | +If you find it useful, you’ll get notified when: |
| 76 | +- new modules are released |
| 77 | +- the full course becomes available |
| 78 | + |
| 79 | +--- |
| 80 | + |
| 81 | +## 👋 Final Note |
| 82 | + |
| 83 | +You can use this kit even if you never buy the course. |
| 84 | +It’s meant to improve real projects, not just sell content. |
| 85 | + |
| 86 | +Happy coding 👋 |
0 commit comments