Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document how to contribute for Windows #125

Merged
merged 1 commit into from
Nov 30, 2022
Merged

Document how to contribute for Windows #125

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 [email protected]:sbt/sbt-github-actions.git
```