diff --git a/.semrelease/this_release b/.semrelease/this_release index 8def5ac..3b57919 100644 --- a/.semrelease/this_release +++ b/.semrelease/this_release @@ -1,3 +1,8 @@ # This file has been cleaned up post-releasing version 0.0.1. # Generate its content quickly using the following command: # git log origin..HEAD | grep "^\s" > .semrelease/this_release +#!VERSION=0.0.2 +- feat: Sample solution with a classlib project and a test project. The class library is ready to be packaged and published as a NuGet package. +- feat: Placeholders for README, LICENSE (MIT), and RELEASE-NOTES. +- feat: Pre-configured .gitignore and .editorconfig files. +- feat: Ready-to-use GitHub Actions workflow for building, testing and releasing the lib to NuGet. diff --git a/README.md b/README.md index 6164de6..12b80e2 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,11 @@ Template project to quickly spin up a C# Class Library project. ## Features -// TODO +- Sample solution with a class library project and a matching xUnit test project. +- The class library is ready to be packaged and published as a NuGet package. +- Placeholders for README, LICENSE (MIT), and RELEASE-NOTES. +- Pre-configured `.gitignore` and `.editorconfig` files. +- Ready-to-use GitHub Actions workflow for building, testing and releasing the library to NuGet. ## Usage @@ -28,6 +32,11 @@ The above command will create a new solution named `MyLib` in the current direct **Happy coding!** +After creating your solution, remember to: +- [ ] Update the package metadata (`PackageId`, `Authors`, `Description`, etc.) in the project file. +- [ ] Fill in `README.md`, `LICENSE.md`, and `RELEASE-NOTES.md`. +- [ ] Configure the GitHub Actions workflow secrets (e.g. the NuGet API key) for releasing. + 🌟 If you find this project useful, please star it. 🌟 ## License @@ -36,6 +45,6 @@ This template is licensed under the MIT License - see the [LICENSE.md](LICENSE.m ## Contributing & Support -Feel free to create [pull requests](https://github.com/DDTH/classlib-template/compare/contribution_queue...) or [issues](https://github.com/DDTH/classlib-template/issues) to report bugs or suggest new features. +Feel free to create [pull requests](https://github.com/DDTH/classlib-template/compare/contrib_wait_to_merge...) or [issues](https://github.com/DDTH/classlib-template/issues) to report bugs or suggest new features. -> Please create PRs against the `contribution_queue` branch. +> Please create PRs against the `contrib_wait_to_merge` branch. diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md index d6a7662..3cee5cf 100644 --- a/RELEASE-NOTES.md +++ b/RELEASE-NOTES.md @@ -1,17 +1 @@ # classlib-template release notes - -## 2026-06-15 - v0.0.1 - -### Changes - -- Rename proj file to Ddth.Templates.Classlib.csproj - -### Added/Refactoring/Deprecation - -- Add workflow automerge-dependabot -- Add CI workflow - -### Fixed/Improvements - -- Fix dir structure and naming -- Fix CI workflow