Setup basic docs.

###############################################################################

# Set default behavior to automatically normalize line endings.

###############################################################################

* text=auto

###############################################################################

# Set default behavior for command prompt diff.

#

# This is need for earlier builds of msysgit that does not have it on by

# default for csharp files.

# Note: This is only used by command line

###############################################################################

#*.cs     diff=csharp

###############################################################################

# Set the merge driver for project and solution files

#

# Merging from the command prompt will add diff markers to the files if there

# are conflicts (Merging from VS is not affected by the settings below, in VS

# the diff markers are never inserted). Diff markers may cause the following 

# file extensions to fail to load in VS. An alternative would be to treat

# these files as binary and thus will always conflict and require user

# intervention with every merge. To do so, just uncomment the entries below

###############################################################################

#*.sln       merge=binary

#*.csproj    merge=binary

#*.vbproj    merge=binary

#*.vcxproj   merge=binary

#*.vcproj    merge=binary

#*.dbproj    merge=binary

#*.fsproj    merge=binary

#*.lsproj    merge=binary

#*.wixproj   merge=binary

#*.modelproj merge=binary

#*.sqlproj   merge=binary

#*.wwaproj   merge=binary

###############################################################################

# behavior for image files

#

# image files are treated as binary by default.

###############################################################################

#*.jpg   binary

#*.png   binary

#*.gif   binary

###############################################################################

# diff behavior for common document formats

# 

# Convert binary document formats to text before diffing them. This feature

# is only available from the command line. Turn it on by uncommenting the 

# entries below.

###############################################################################

#*.doc   diff=astextplain

#*.DOC   diff=astextplain

#*.docx  diff=astextplain

#*.DOCX  diff=astextplain

#*.dot   diff=astextplain

#*.DOT   diff=astextplain

#*.pdf   diff=astextplain

#*.PDF   diff=astextplain

#*.rtf   diff=astextplain

#*.RTF   diff=astextplain

## Ignore Visual Studio temporary files, build results, and

## files generated by popular Visual Studio add-ons.

# User-specific files

*.suo

*.user

*.userosscache

*.sln.docstates

# User-specific files (MonoDevelop/Xamarin Studio)

*.userprefs

# Build results

[Dd]ebug/

[Dd]ebugPublic/

[Rr]elease/

[Rr]eleases/

[Xx]64/

[Xx]86/

[Bb]uild/

bld/

[Bb]in/

[Oo]bj/

# Visual Studio 2015 cache/options directory

.vs/

# Uncomment if you have tasks that create the project's static files in wwwroot

#wwwroot/

# MSTest test Results

[Tt]est[Rr]esult*/

[Bb]uild[Ll]og.*

# NUNIT

*.VisualState.xml

TestResult.xml

# Build Results of an ATL Project

[Dd]ebugPS/

[Rr]eleasePS/

dlldata.c

# DNX

project.lock.json

artifacts/

*_i.c

*_p.c

*_i.h

*.ilk

*.meta

*.obj

*.pch

*.pdb

*.pgc

*.pgd

*.rsp

*.sbr

*.tlb

*.tli

*.tlh

*.tmp

*.tmp_proj

*.log

*.vspscc

*.vssscc

.builds

*.pidb

*.svclog

*.scc

# Chutzpah Test files

_Chutzpah*

# Visual C++ cache files

ipch/

*.aps

*.ncb

*.opendb

*.opensdf

*.sdf

*.cachefile

*.VC.db

# Visual Studio profiler

*.psess

*.vsp

*.vspx

*.sap

# TFS 2012 Local Workspace

$tf/

# Guidance Automation Toolkit

*.gpState

# ReSharper is a .NET coding add-in

_ReSharper*/

*.[Rr]e[Ss]harper

*.DotSettings.user

# JustCode is a .NET coding add-in

.JustCode

# TeamCity is a build add-in

_TeamCity*

# DotCover is a Code Coverage Tool

*.dotCover

# NCrunch

_NCrunch_*

.*crunch*.local.xml

nCrunchTemp_*

# MightyMoose

*.mm.*

AutoTest.Net/

# Web workbench (sass)

.sass-cache/

# Installshield output folder

[Ee]xpress/

# DocProject is a documentation generator add-in

DocProject/buildhelp/

DocProject/Help/*.HxT

DocProject/Help/*.HxC

DocProject/Help/*.hhc

DocProject/Help/*.hhk

DocProject/Help/*.hhp

DocProject/Help/Html2

DocProject/Help/html

# Click-Once directory

publish/

# Publish Web Output

*.[Pp]ublish.xml

*.azurePubxml

# TODO: Un-comment the next line if you do not want to checkin 

# your web deploy settings because they may include unencrypted

# passwords

#*.pubxml

*.publishproj

# NuGet Packages

*.nupkg

# The packages folder can be ignored because of Package Restore

**/packages/*

# except build/, which is used as an MSBuild target.

!**/packages/build/

# Uncomment if necessary however generally it will be regenerated when needed

#!**/packages/repositories.config

# NuGet v3's project.json files produces more ignoreable files

*.nuget.props

*.nuget.targets

# Microsoft Azure Build Output

csx/

*.build.csdef

# Microsoft Azure Emulator

ecf/

rcf/

# Microsoft Azure ApplicationInsights config file

ApplicationInsights.config

# Windows Store app package directory

AppPackages/

BundleArtifacts/

# Visual Studio cache files

# files ending in .cache can be ignored

*.[Cc]ache

# but keep track of directories ending in .cache

!*.[Cc]ache/

# Others

ClientBin/

[Ss]tyle[Cc]op.*

~$*

*~

*.dbmdl

*.dbproj.schemaview

*.pfx

*.publishsettings

node_modules/

orleans.codegen.cs

# RIA/Silverlight projects

Generated_Code/

# Backup & report files from converting an old project file

# to a newer Visual Studio version. Backup files are not needed,

# because we have git ;-)

_UpgradeReport_Files/

Backup*/

UpgradeLog*.XML

UpgradeLog*.htm

# SQL Server files

*.mdf

*.ldf

# Business Intelligence projects

*.rdl.data

*.bim.layout

*.bim_*.settings

# Microsoft Fakes

FakesAssemblies/

# GhostDoc plugin setting file

*.GhostDoc.xml

# Node.js Tools for Visual Studio

.ntvs_analysis.dat

# Visual Studio 6 build log

*.plg

# Visual Studio 6 workspace options file

*.opt

# Visual Studio LightSwitch build output

**/*.HTMLClient/GeneratedArtifacts

**/*.DesktopClient/GeneratedArtifacts

**/*.DesktopClient/ModelManifest.xml

**/*.Server/GeneratedArtifacts

**/*.Server/ModelManifest.xml

_Pvt_Extensions

# LightSwitch generated files

GeneratedArtifacts/

ModelManifest.xml

# Paket dependency manager

.paket/paket.exe

# FAKE - F# Make

.fake/

 No newline at end of file

# Contributing to the Windows Device Portal Wrapper

The Windows Device Portal Wrapper welcomes contributions from the community.

# Process

1. [Make a proposal](https://github.com/Microsoft/WindowsDevicePortalWrapper/issues) (either new, or for one of the elements in our backlog)

2. Implement the proposal and its tests.

3. Run StyleCop and ensure compliance.

4. Rebase commits to tell a compelling story.

5. Start a pull request & address comments.

6. Merge.

# Proposal

For things like fixing typos and small bug fixes, you can skip this step.

If your change is more than a simple fix, please don't just create a big pull request. 

Instead, start by [opening an issue](https://github.com/Microsoft/WindowsDevicePortalWrapper/issues) describing the problem you want to solve and how you plan to approach the problem. This will let us have a brief discussion about the problem and, hopefully, identify some potential pitfalls before too much time is spent.

Note:  If you wish to work on something that already exists on our backlog, you can use that work item as your proposal.  

# Implementation

1. Fork the repository. Click on the "Fork" button on the top right of the page and follow the flow.

2. If your work needs more time, the consider branching off of master else just code in your fork.

3. Ensure your changes check for the appropriate device families (ex: Windows Desktop and IoT only).

4. Implement one or more [tests](https://github.com/Microsoft/WindowsDevicePortalWrapper/blob/master/Testing.md) to ensure the change works on the target platform(s).

5. Make small and frequent commits that include [tests](https://github.com/Microsoft/WindowsDevicePortalWrapper/blob/master/Testing.md) against mock data or manual tests which can be run against real devices.

6. Make sure that all existing [tests](https://github.com/Microsoft/WindowsDevicePortalWrapper/blob/master/Testing.md) continue to pass.

# Updating code documentation

The Windows Device Portal Wrapper uses [Doxygen](http://www.stack.nl/~dimitri/doxygen/download.html) to automatically generate code documentation directly from the source code. Any changes to existing or new classes or methods should also update the documentation.

1. Download and install [Doxygen](http://www.stack.nl/~dimitri/doxygen/download.html) (our docs are generated using version 1.8.11).

2. Open a CMD prompt and navigate to your git repository's root directory.

3. Run '\<Doxygen Install Location\>\\doxygen.exe DocConfig.txt'. This will update the files under the html folder relative to the root directory.

4. Include the updated files with your PR.

# Run StyleCop

The Windows Device Portal Wrapper uses the [StyleCop](http://stylecop.codeplex.com) code analysis tool to ensure code consistency and readability. This step is required for the WindowsDevicePortalWrapper folder and is optional (though highly recommended) for test applications.

1. Download and install the latest version of StyleCop.

2. Run StyleCop analysis on the project (In Visual Studio 2015, select Tools > Run StyleCop).

3. Update the source code to address detected issues.

4. Repeat steps 2 and 3 until analysis detects no issues.

If there is a StyleCop issue that you believe does not need to be enforced, please add the suppression entry either to your code or the Settings.StyleCop file in the appropriate folder. This will highlight the rule change and allow the community to comment.

# Rebase commits

The commits in your pull request should tell a story about how the code got from point A to point B. 

Good stories are edited, so you'll want to rebase your commits so that they tell a good story.

Each commit should build and pass all of the tests. 

If you want to add new tests for functionality that's not yet written, ensure the tests are added disabled.

Don't forget to run git diff --check to catch those annoying whitespace changes.

Please follow the established [Git convention for commit messages](https://www.git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#Commit-Guidelines). 

The first line is a summary in the imperative, about 50 characters or less, and should not end with a period. 

An optional, longer description must be preceded by an empty line and should be wrapped at around 72 characters. 

This helps with various outputs from Git or other tools.

You can update message of local commits you haven't pushed yet using git commit --amend or git rebase --interactivewith reword command.

# Pull request

Start a GitHub pull request to merge your topic branch into the [main repository's master branch](https://github.com/Microsoft/WindowsDevicePortalWrapper/tree/master). 

(If you are a Microsoft employee and are not a member of the [Microsoft organization on GitHub](https://github.com/Microsoft) yet, please contact the DDE team via e-mail for instructions before starting your pull request. There's some process stuff you'll need to do ahead of time.)

If you haven't contributed to a Microsoft project before, you may be asked to sign a [contribution license agreement](https://cla.microsoft.com/). 

A comment in the PR will let you know if you do.

The project maintainers will review your changes. We aim to review all changes within three business days.

Address any review comments, force push to your topic branch, and post a comment letting us know that there's new stuff to review.

# Merge

If the pull request review goes well, a project maintainer will merge your changes. Thank you for helping improve the Windows Device Portal Wrapper!

MIT License

Copyright (c) 2016 Microsoft Corporation

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in

all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

THE SOFTWARE.

 No newline at end of file