xref: /Couchbase_NET_Client_v3.0/README.md (revision b41f3578)
1The Official Couchbase .NET SDK [![Build Status](http://sdkbuilds.sc.couchbase.com/buildStatus/icon?job=netclient-build-test)](http://sdkbuilds.sc.couchbase.com/job/netclient-build-test/) [![Join the chat at https://gitter.im/couchbase/discuss](https://badges.gitter.im/couchbase/discuss.svg)](https://gitter.im/couchbase/discuss?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
2
3* master is 2.0 development branch
4* release13 is 1.3.X development branch
5
6## Getting Started
7
8To get up and running with the SDK, please visit the [online documentation](http://developer.couchbase.com/documentation/server/4.5/sdk/dotnet/start-using-sdk.html).
9
10## Running Tests
11
12We maintain a collection of both unit and integration test projects, with a version for the full .NET framework and Net Standard (projects with a NetStandard suffix).
13
14### Unit Tests
15
16There are two unit tests projects, Couchbase.UnitTests and Couchbase.UnitTests.NetStandard, that contain environment independent tests and do not require a local cluster to run.
17
18### Running the Integration Tests ##
19
20There are two integration test projects, Couchbase.IntegrationTests and Couchbase.IntegationTests.NetStandard, and require the following  to run:
21
221. Couchbase Server >= 4.0 installed on localhost
232. The "beer-sample" and "travel-sample" sample buckets installed. They can be installed by logging into the Couchbase Console (http://localhost:8091) and then Settings->Sample Buckets.
243. The following buckets installed on localhost:
25	1. "default" - the standard default bucket
26	2. "authenticated" - a Couchbase bucket with a password of "secret"
27	3. "memcached" - a Memcached bucket with no password
284. Install an SSL certificate (copied from the Couchbase console Security->Root Certificate)
295. A default primary index configured for both the `default` and `authenticated` buckets (eg <code>create primary index on &#96;default&#96;</code> and <code>create primary index on &#96;authenticated&#96;</code>)
306. Add an FTS index to the *travel-sample* bucket called `idx-travel`
31
32## Pull Requests and Submissions ##
33Being an Open Source project, the Couchbase SDK depends upon feedback and submissions from the community. If you feel as if you want to submit a bug fix or a feature, please post a Pull Request. The Pull Request will go through a formal code review process and merged after being +2'd by a Couchbase Engineer. In order to accept a submission, Couchbase requires that all contributors sign the Contributor License Agreement (CLA). You can do this by creating an account in [Gerrit](http://review.couchbase.com), our official Code Review system. After you have created your account, login and check the CLA checkbox.
34
35Once the CLA is signed, a Couchbase engineer will push the pull request to Gerrit and one or more Couchbase engineers will review the submission. If it looks good they will then +2 the changeset and merge it with master. In addition, if the submission needs more work, you will need to amend the Changeset with another Patchset. Note that is strongly encouraged to submit a Unit Test with each submission and also include a description of the submission, what changed and what the result is.
36
37<img src="https://d3nmt5vlzunoa1.cloudfront.net/dotnet/files/2016/08/ReSharper2016_2_2_512x197.png" height="100"></img>
38