Skip to content

Commit d333cbf

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

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

45-
#Building the solution
45+
# Building the solution
4646

4747
The solution uses a number of awesome Open Source software tools to ease development:
4848

49-
##Paket
49+
## Paket
5050

5151
[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.
5252

53-
##FAKE
53+
## FAKE
5454

5555
[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
5656

@@ -73,7 +73,7 @@ This will
7373

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

76-
##Tests
76+
## Tests
7777

7878
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
7979

@@ -104,9 +104,9 @@ build.bat Integrate [Elasticsearch Version Number e.g. 5.0.0]
104104
```
105105
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.
106106

107-
##Troubleshooting
107+
## Troubleshooting
108108

109-
###Could not load file or assembly FSharp.Core
109+
### Could not load file or assembly FSharp.Core
110110

111111
You may come across an exception similar to below when running the build script
112112

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

118118
If working on both 1.x and 2.x and 5.x 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.
119119

120+
### System.Exception: Attempting to run with dotnet.exe with 1.0.x but global.json mandates 1.0.1
121+
122+
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.
123+
124+
```json
125+
{
126+
"sdk": {
127+
"version": "1.0.1"
128+
}
129+
}
130+
```

0 commit comments

Comments
 (0)