|
|
## C# Template
|
|
|
|
|
|
This template includes:
|
|
|
|
|
|
* Automatic building using cake
|
|
|
* Automatic testing with NUnit
|
|
|
* Automatic linting with Resharper
|
|
|
* Automatic documentation publishing using Gitlab CI / CD and a self written script which puts the docs in the docs folder to the wiki
|
|
|
* Automatic releases using semantic-release ([ESLint Code Convention](ESLintConvention)), cake and Gitlab CI / CD
|
|
|
|
|
|
## What you need to do
|
|
|
|
|
|
Place you C# project solution file in .src/.
|
|
|
Make sure Create directory for solution is unticked.
|
|
|
|
|
|
![alt text](images/create_project.png "Create a new Project")
|
|
|
|
|
|
Delete unused docs and update this README.
|
|
|
|
|
|
Add [NUnit](nunit) tests to your solution.
|
|
|
|
|
|
## Building
|
|
|
|
|
|
Build this project by running either the build.ps1 or the build<span></span>.sh script.
|
|
|
The project will be build and tested.
|
|
|
|
|
|
### Links
|
|
|
|
|
|
* [Commit convention](ESLintConvention)
|
|
|
* [Everything possible with markup](testdoc)
|
|
|
* [Adding NUnit tests](nunit) |