From 2794d0d4b3812ff7b9ba3e06a2c9fa25c25624fe Mon Sep 17 00:00:00 2001 From: NextTurn <45985406+NextTurn@users.noreply.github.com> Date: Thu, 29 Nov 2018 00:00:00 +0800 Subject: [PATCH] Initialize contributing guidelines --- CONTRIBUTING.md | 28 ++++++++++++++++++++++++++++ DEVELOPER.md | 9 --------- 2 files changed, 28 insertions(+), 9 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..ddc8ccd --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,28 @@ +# Contributing + +## Prerequisites + +You need to install either of the followings to develop .NET. + +- [Visual Studio 2019](https://visualstudio.microsoft.com/downloads/) with *.NET desktop development* workload, which includes .NET SDK. +- .NET SDK and your favorite code editor. + - You can find .NET SDK installation instructions on the [Download .NET](https://dotnet.microsoft.com/download) page. + - You can try [Visual Studio Code](https://code.visualstudio.com/Download), which is an open source and cross-platform editor. + +## Developing in Visual Studio + +You can open `src\winsw.sln` and then build and run tests from within Visual Studio. + +## Developing with .NET SDK + +### Building + +``` +dotnet build src\winsw.sln +``` + +### Testing + +``` +dotnet test src\Test\winswTests\winswTests.csproj +``` diff --git a/DEVELOPER.md b/DEVELOPER.md index cbbb9f7..7a1944e 100644 --- a/DEVELOPER.md +++ b/DEVELOPER.md @@ -3,18 +3,9 @@ WinSW Developer Information ### Build Environment -* IDE: [Visual Studio Community 2019](https://visualstudio.microsoft.com/vs/) (free for open-source projects) * *winsw_key.snk* should be available in the project's root in order to build the executable * You can generate the certificate by running *generate-key.ps1* * The certificate is in *.gitignore* list. Please do not add it to the repository - -### Testing - -WinSW includes a set of tests powered by the [NUnit](https://www.nunit.org/) test framework. -In order to run tests you can install [NUnit Console](https://github.com/nunit/nunit-console) on the build machine. - -Once you build the solution, you will be able to find the test DLL with dependencies in the `src/Test/winswTests/bin` directory. -In NUnit Console you can just import projects from this directory and then run tests. ### Continuous Integration