Skip to content

Commit eb99c04

Browse files
Chris PerksMpdreamz
authored andcommitted
Added troubleshooting section, corrected heading markdown tags (#2768)
1 parent de61b70 commit eb99c04

File tree

1 file changed

+18
-7
lines changed

1 file changed

+18
-7
lines changed

contributing.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#Contributing
1+
# Contributing
22

33
Contributing back to `Elasticsearch.Net` and `NEST` is very much appreciated.
44
Whether you [feel the need to change one character](https://github.com/elasticsearch/elasticsearch-net/pull/536) or have a go at
@@ -38,15 +38,15 @@ Please submit your [Pull Requests](https://help.github.com/articles/creating-a-p
3838
- [`master`](https://github.com/elastic/elasticsearch-net/tree/master) branch for 2.0
3939
- [`1.x`](https://github.com/elastic/elasticsearch-net/tree/1.x) branch for 1.x
4040

41-
#Building the solution
41+
# Building the solution
4242

4343
The solution uses a number of awesome Open Source software tools to ease development:
4444

45-
##Paket
45+
## Paket
4646

4747
[Paket](https://fsprojects.github.io/Paket/) is the dependency manager of choice for handling dependencies of both the solution and the build automation system. It works for both .NET and Mono, with an ability to reference packages from Nuget and also files directly from github.
4848

49-
##FAKE
49+
## FAKE
5050

5151
[FAKE (F# MAKE)](http://fsharp.github.io/FAKE/) is used as the build automation system for the solution. To get started after cloning the solution, it's best to run the build script in the root
5252

@@ -69,13 +69,13 @@ This will
6969

7070
You can also compile the solution within Visual Studio if you prefer, but the build script is going to be faster.
7171

72-
##Tests
72+
## Tests
7373

7474
The `Tests` project contains both xunit unit and integration tests. A `tests.yaml` file within the root of the `Tests` project determines the test mode when running tests inside Visual Studio; the build script has a number of different build targets to run different types of tests, see the `Targets.fsx` script in the `scripts` project for the complete list.
7575

76-
##Troubleshooting
76+
## Troubleshooting
7777

78-
###Could not load file or assembly FSharp.Core
78+
### Could not load file or assembly FSharp.Core
7979

8080
You may come across an exception similar to below when running the build script
8181

@@ -86,3 +86,14 @@ The `1.x` and `master` branches have diverged dramatically as a result of change
8686

8787
If working on both 1.x and 2.0 versions of NEST, it is recommended to clone the git repository for each version into separate directories to avoid the need to switch between the divergent branches.
8888

89+
### System.Exception: Attempting to run with dotnet.exe with 1.0.x but global.json mandates 1.0.1
90+
91+
When running the `build` script, you may encounter a mismatch with your version of the .NET Core runtime. Ensure your version of .NET Core exactly matches the version specified under `sdk` in the `global.json` file.
92+
93+
```json
94+
{
95+
"sdk": {
96+
"version": "1.0.1"
97+
}
98+
}
99+
```

0 commit comments

Comments
 (0)