Every great .NET application—whether it's a high-frequency trading platform, an enterprise ERP, or a mobile game—is built on a solid foundation of reusable class libraries. However, designing a library that is easy to maintain, test, version, and distribute is an art form. Csharp Class Library Framework is a production-ready, opinionated template designed to eliminate the boilerplate and enforce best practices from day one.
This repository is not just a starting point; it is a complete architectural blueprint. It provides a structured solution template with pre-configured projects for the core library, unit tests, integration tests, benchmarks, and NuGet packaging. It enforces strict coding standards, dependency injection, and clean architecture principles, ensuring your code remains maintainable as it scales.
Whether you are a solo developer publishing open-source utilities or part of an enterprise team building internal SDKs, this framework saves you weeks of setup time. It includes continuous integration pipelines for GitHub Actions, automated semantic versioning, and a beautiful documentation site generated via DocFX.
We have structured the solution to follow the Onion Architecture, ensuring your business logic is isolated from external dependencies. Here is how the projects are organized:
This is the heart of your library. It contains the interfaces, domain models, and business logic. It has zero external dependencies, making it incredibly fast to test and easy to port. It defines the contracts that the rest of the application will implement.
This project contains the concrete implementations of the interfaces defined in the Core. For example, if your Core defines an IEmailService, the Infrastructure project contains the SmtpEmailService. This separation allows you to swap out implementations without touching the core logic.
We provide a comprehensive testing setup using xUnit and Moq. It includes unit tests for the core logic, integration tests for the infrastructure, and mutation tests using Stryker.NET to ensure your tests are actually catching bugs.
Performance matters. This project uses BenchmarkDotNet to measure the execution time and memory allocation of your critical methods. It generates beautiful, statistically rigorous reports so you can prove your library is fast.
We provide a pre-configured .csproj file with all the metadata required for NuGet publishing. It includes a custom icon, README embedding, and SourceLink support, ensuring your package looks professional on NuGet.org.
We believe that deployment should be as simple as pushing code. The framework includes a fully configured GitHub Actions workflow.
| Stage | Description |
|---|---|
| Build | Restores dependencies and builds the solution in Release mode |
| Test | Runs all unit and integration tests with code coverage reporting |
| Benchmark | Runs performance benchmarks and detects regressions |
| Package | Automatically versions and packages the library as a .nupkg |
| Publish | Pushes the package to NuGet.org when a new tag is created |
This framework includes support for C# Source Generators. Source Generators are a compiler feature that allows you to inspect your code and generate additional C# files on the fly.
We use this to automatically generate boilerplate code. For example, if you decorate a class with [AutoImplement], the source generator automatically creates the INotifyPropertyChanged implementation for all your properties. This eliminates hundreds of lines of tedious code while maintaining full compile-time safety. We also provide a template for creating your own source generators, allowing you to automate your own repetitive patterns.
We believe that great libraries are built by communities, not individuals. If you have suggestions for improving the architecture, found a bug in the pipeline, or want to add support for a new testing framework, we welcome your contributions!
- Fork the repository.
- Create your feature branch (
git checkout -b feature/new-generator). - Commit your changes (
git commit -m 'Add new source generator'). - Push to the branch (
git push origin feature/new-generator). - Open a Pull Request.
Please read our CONTRIBUTING.md for detailed coding standards and testing requirements. We also have an active Discord server where you can share your libraries, ask for help with NuGet publishing, and discuss the latest trends in .NET development.
- 💬 Discussions: Join the conversation in the GitHub Discussions tab.
- 🐛 Issues: Found a bug? Let us know via the Issues tracker.
- 📧 Email: Reach out directly at support@csharp-library.dev.
