Skip to content

Commit

Permalink
Add FAQ for obscure SDK missing error message
Browse files Browse the repository at this point in the history
Issue #648 did not state the exact error that occurred when opening the solution but if the SDK is missing (as described in novotnyllc/MSBuildSdkExtras#190) the solution fails to load.

This is an obscure error message that is hard to search for within this repository. The modification adds a simple and prominent FAQ that explains the problem and how to fix it.
  • Loading branch information
mbreckon authored Jul 10, 2020
1 parent 6d275af commit 8ee797a
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,27 @@

Thanks for wanting to contribute to Caliburn.Micro. Contributions don't need to take the form of code, submitting issues and writing documentation is just as important.

## FAQ: I see an error when opening the solution
```error : The expression "[System.IO.Path]::GetDirectoryName('')" cannot be evaluated. The path is not of a legal form.```

This (unhelpfully) seems to be caused by not having the correct .NET Core SDK installed (see https://github.com/novotnyllc/MSBuildSdkExtras/issues/190).

To find the version of the SDK that Caliburn Micro requires go to src/global.json.

e.g.
```
{
"sdk": {
"version": "3.1.300"
},
"msbuild-sdks": {
"MSBuild.Sdk.Extras": "2.0.54"
}
}
```

Once this version listed in the global.json file is installed the solution will open with all the projects loaded. If the correct versions of the SDKs for Android, UAP and Xamarin are not installed there are error messages at build time that contain instructions on how to proceed.

## Raising Issues

Basic support is provided by the community on [Stack Overflow][http://stackoverflow.com/questions/tagged/caliburn.micro] including the core contributors.
Expand Down Expand Up @@ -78,4 +99,4 @@ Some things that will increase the chance that your pull request is accepted.

* [Caliburn.Micro documentation](http://caliburnmicro.com/documentation/)
* [General GitHub documentation](http://help.github.com/)
* [Stack Overflow](http://stackoverflow.com/questions/tagged/caliburn.micro)
* [Stack Overflow](http://stackoverflow.com/questions/tagged/caliburn.micro)

0 comments on commit 8ee797a

Please sign in to comment.