Skip to content

Commit de0a357

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

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
@@ -40,15 +40,15 @@ Please submit your [Pull Requests](https://help.github.com/articles/creating-a-p
4040
- [`2.x`](https://github.com/elastic/elasticsearch-net/tree/2.x) branch for 2.x
4141
- [`1.x`](https://github.com/elastic/elasticsearch-net/tree/1.x) branch for 1.x
4242

43-
#Building the solution
43+
# Building the solution
4444

4545
The solution uses a number of awesome Open Source software tools to ease development:
4646

47-
##Paket
47+
## Paket
4848

4949
[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.
5050

51-
##FAKE
51+
## FAKE
5252

5353
[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
5454

@@ -71,7 +71,7 @@ This will
7171

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

74-
##Tests
74+
## Tests
7575

7676
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
7777

@@ -95,9 +95,9 @@ build.bat Integrate [Elasticsearch Version Number e.g. 2.2.0]
9595
```
9696
will quick compile the solution and run integration tests against the target Elasticsearch version. The first time this is run for a version of Elasticsearch, it will download Elasticsearch and unzip Elasticsearch, install the plugins necessary to run the integration tests, and start the node. Because of this, the first run may take some time to start.
9797

98-
##Troubleshooting
98+
## Troubleshooting
9999

100-
###Could not load file or assembly FSharp.Core
100+
### Could not load file or assembly FSharp.Core
101101

102102
You may come across an exception similar to below when running the build script
103103

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

109109
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.
110110

111+
### System.Exception: Attempting to run with dotnet.exe with 1.0.x but global.json mandates 1.0.1
112+
113+
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.
114+
115+
```json
116+
{
117+
"sdk": {
118+
"version": "1.0.1"
119+
}
120+
}
121+
```

0 commit comments

Comments
 (0)