About • How To Use • Download • Building • Contributing • Versioning • Credits • Related • License
Tip
What to do next after generating the template
The template makes a lot of assumptions, so after generating the project, there's a couple of things you can tweak.
- Update the
Readme.mdandPackageReadme.mdwith information about your library - Review the guidelines in
CONTRIBUTING.mdto see if it aligns with how you want to handle contributions - Review the issue templates under
.github/issue_template - Set-up labels in GitHub matching those in the
release.ymlso you can label pull requests accordingly - Adjust the .NET frameworks this library should target
- Adjust the root namespace and assembly names
- Alter the coverage service that is being used.
- Determine if you want to use API verification against snapshots
- Study the Nuke
build.csfile or invoking it throughbuild.ps1 -planto see how it works - See if all dependencies are up-to-date
- Configure NuGet auditing (see next paragraph)
- Fine-tune the allowed open-source licenses and packages in the
.\packageguard\config.json - Store the PackageGuard cache that appears under
.\packageguardafter a first build in source control to speed-up successive runs - Adjust the
funding.ymlto allow people to sponsor your project - Review the code of conduct to see if it matches your opinions
Note
Before the first time the build script has run on your new solution, the .nuspec file is still called nuspec. This was needed because dotnet pack refuses to include the .nuspec file in the template package this repository produces. This file is automatically renamed after the first time the build.ps1 script is run.
Tip
Also check-out the main repository for additional information on these generated solutions.
Add stuff like:
- Mockly.Http offers
- what .NET, C# other versions of dependencies it supports
- What makes it different from other libraries?
- Why did you create it.
- What problem does it solve?
-
Something about you, your company, your team, etc.
-
How to contact you like LinkedIn, Twitter, Bluesky, Mastodon, email, etc.
- Code examples
- Where to find more examples
Some example code showing your libraryThis library is available as a NuGet package on https://nuget.org. To install it, use the following command-line:
dotnet add package mockly.http
To build this repository locally, you need the following:
- The .NET SDKs for .NET 4.7 and 8.0.
- Visual Studio, JetBrains Rider or Visual Studio Code with the C# DevKit
You can also build, run the unit tests and package the code using the following command-line:
build.ps1
Or, if you have, the Nuke tool installed:
nuke
Also try using --help to see all the available options or --plan to see what the scripts does.
Your contributions are always welcome! Please have a look at the contribution guidelines first.
Previous contributors include:
(Made with contrib.rocks)
This library uses Semantic Versioning to give meaning to the version numbers. For the versions available, see the tags on this repository.
This library wouldn't have been possible without the following tools, packages and companies:
- Nuke - Smart automation for DevOps teams and CI/CD pipelines by Matthias Koch
- xUnit - Community-focused unit testing tool for .NET by Brad Wilson
- Coverlet - Cross platform code coverage for .NET by Toni Solarin-Sodara
- Polysharp - Generated, source-only polyfills for C# language features by Sergio Pedri
- GitVersion - From git log to SemVer in no time
- ReportGenerator - Converts coverage reports by Daniel Palme
- StyleCopyAnalyzer - StyleCop rules for .NET
- Roslynator - A set of code analysis tools for C# by Josef Pihrt
- CSharpCodingGuidelines - Roslyn analyzers by Bart Koelman to go with the C# Coding Guidelines
- Meziantou - Another set of awesome Roslyn analyzers by Gérald Barré
- Verify - Snapshot testing by Simon Cropp
- Your blog
- Your other projects
- Related projects you think are cool or interesting for the consumers of this project
This project is licensed under the MIT License - see the LICENSE file for details.
