From 4ab76e9ef61beab0f6541139a251eb4daf7b16b7 Mon Sep 17 00:00:00 2001 From: Matthew de Detrich Date: Wed, 30 Nov 2022 12:39:40 +0100 Subject: [PATCH] Document how to contribute for Windows --- CONTRIBUTING.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..dba478d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,20 @@ +# Contributing to sbt-github-actions + +## Windows + +Currently, the project uses symbolic links which requires special handling when working on Windows. +Firstly you need to make sure that you have [mklink](https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/mklink) +permissions as a user, the easiest way to do this is if you happen to be running Windows 10/Windows 11 +is to enable [Developer Mode](https://learn.microsoft.com/en-us/windows/apps/get-started/developer-mode-features-and-debugging?source=recommendations). +After this is done then you can enable `symlinks` globally by doing + +```shell +git config --global core.symlinks true +``` + +Alternately if you don't want to enable `symlinks` globally you can just selectively enable it when checking +out this repository, i.e. + +```shell +git clone -c core.symlinks=true git@github.com:sbt/sbt-github-actions.git +```