(This project is under construction at the moment; be cautious of incomplete instructions.)
Everything you need to get a quick start for a C# project on GitHub! Useful as a template, a few find+replace actions and you're immediately ready to go, or just a useful reference. Contains:
- All the special GitHub project files to make your project polished.
- A variety of sample projects to fit whatever you want to do.
- Build workflows with test coverage collection.
- Clean project structure with all output directed to './artifacts'.
- Even the start of a documentation site using GitHub pages.
Customize the project for your own use by following these steps:
- Replace all instance of "Werecodent" with your organization's name (or empty).
- Replace all instances of "UltimateProjectStarter" with your project's name.
- Install "CodeCov" as a GitHub app to the project/organization and set it up, or remove all references.
- Tweak existing code as needed and begin coding.
The documentation site is located here: https://Werecodent.github.io/UltimateProjectStarter/
The raw files can be viewed from the docs folder or built into a local site using Jekyll.
If you're looking to contribute, thanks for your interest. Feel free to submit reports for any issues you can find, or request potential features you'd like to see here. If you wish to contribute code to the project, refer to the contributing guidelines here which also include instructions for environment setup. Please follow the code of conduct when contributing.
This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/.
View the license file for more details.
- CreateAndFake: For testing behavior.
- xUnit + bUnit: For running tests.
- Coverlet + ReportGenerator + CodeCov: For test coverage.
- Bullseye + SimpleExec + MinVer: For project building.
- AsyncFixer + MissingAwaitWarning + Meziantou.Analyzer + Sonar: For code analyzers.
- CSharpier: For formatting code.
- GitHub: For hosting code.
- Microsoft: For C# and editors.