Merge pull request #172 from begoldsm/master

Add templates and contributing files.

.github/CONTRIBUTING.md

@@ -0,0 +1,106 @@
+# Contribute Code or Provide Feedback for Azure Data Lake Store Filesystem SDK for Python
+
+This repository contains The Azure Data Lake Store Filesystem SDK for Python that can be consumed for Microsoft Azure applications.
+
+## Basics
+
+If you would like to become an active contributor to this project, please follow the instructions provided in [Microsoft Azure Projects Contribution Guidelines](http://azure.github.io/guidelines/).
+
+## Table of Contents
+
+[Before Starting](#before-starting)
+- [Onboarding](#onboarding)
+- [GitHub Basics](#github-basics)
+    - [GitHub Workflow](#github-workflow)
+    - [Forking the Azure/azure-data-lake-store-python repository](#forking-the-azureazure-data-lake-store-python-repository)
+- [Code of Conduct](#code-of-conduct)
+
+[Filing Issues](#filing-issues)
+
+[Making Changes](#making-changes)
+- [Pull Requests](#pull-requests)
+- [Pull Request Guidelines](#pull-request-guidelines)
+    - [Cleaning up commits](#cleaning-up-commits)
+    - [Breaking changes](#breaking-changes)
+    - [General guidelines](#general-guidelines)
+    - [Testing guidelines](#testing-guidelines)
+
+## Before Starting
+
+### Onboarding
+
+Before cloning this repository, please make sure you have started in our [documentation repository](https://github.com/Azure/adx-documentation-pr) (you will only have access to that page if you are part of the Azure organization).
+
+### GitHub Basics
+
+#### GitHub Workflow
+
+If you don't have experience with Git and GitHub, some of the terminology and process can be confusing. [Here is a guide to understanding the GitHub flow](https://guides.github.com/introduction/flow/) and [here is a guide to understanding the basic Git commands](https://services.github.com/kit/downloads/github-git-cheat-sheet.pdf).
+
+### Forking the Azure/azure-data-lake-store-python repository
+
+Unless you are working with multiple contributors on the same file, we ask that you fork the repository and submit your pull request from there. [Here is a guide to forks in GitHub](https://guides.github.com/activities/forking/).
+
+###  Code of Conduct
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
+
+## Filing Issues
+
+You can find all of the issues that have been filed in the [Issues](https://github.com/Azure/azure-data-lake-store-python/issues) section of the repository.
+
+If you encounter any bugs with Azure Data Lake Store Filesystem SDK for Python, or would like to request a feature, please file an issue [here](https://github.com/Azure/azure-data-lake-store-python/issues/new).
+
+You can find the dates for the next three sprints for Azure Data Lake Store Filesystem SDK for Python in the [Milestones](https://github.com/Azure/azure-data-lake-store-python/milestones) section of the Issue page. Each milestone will display the issues that are being worked on for each corresponding sprint.
+
+## Making Changes
+
+### Pull Requests
+
+You can find all of the pull requests that have been opened in the [Pull Request](https://github.com/Azure/azure-data-lake-store-python/pulls) section of the repository.
+
+To open your own pull request, click [here](https://github.com/Azure/azure-data-lake-store-python/compare). When creating a pull request, keep the following in mind:
+- Make sure you are pointing to the fork and branch that your changes were made in
+- Choose the correct branch you want your pull request to be merged into
+    - The **AutoRest** branch is for code generated from AutoRest
+    - The **master** branch is for code generated from Hyak; code in this branch is in support mode only
+    - The **Fluent** branch is for the next generation of Azure SDK Management libraries that implement Fluent interfaces
+- The pull request template that is provided **should be filled out**; this is not something that should just be deleted or ignored when the pull request is created
+    - Deleting or ignoring this template will elongate the time it takes for your pull request to be reviewed
+- The SLA for reviewing pull requests is **two business days**
+
+### Pull Request Guidelines
+
+A pull request template will automatically be included as a part of your PR. Please fill out the checklist as specified. Pull requests **will not be reviewed** unless they include a properly completed checklist.
+
+#### Cleaning up Commits
+
+If you are thinking about making a large change to your SDK, **break up the change into small, logical, testable chunks, and organize your pull requests accordingly**.
+
+Often when a pull request is created with a large number of files changed and/or a large number of lines of code added and/or removed, GitHub will have a difficult time opening up the changes on their site. This forces the Azure Data Lake Store Filesystem SDK for Python team to use separate software to do a code review on the pull request.
+
+If you find yourself creating a pull request and are unable to see all the changes on GitHub, we recommend **splitting the pull request into multiple pull requests that are able to be reviewed on GitHub**.
+
+If splitting up the pull request is not an option, we recommend **creating individual commits for different parts of the pull request, which can be reviewed individually on GitHub**.
+
+For more information on cleaning up the commits in a pull request, such as how to rebase, squash, and cherry-pick, click [here](https://github.com/Azure/azure-powershell/blob/dev/documentation/cleaning-up-commits.md).
+
+#### Breaking Changes
+
+Breaking changes should **not** be introduced into the repository without giving customers at least six months notice. For a description of breaking changes in Azure Data Lake Store Filesystem SDK for Python, see [here](https://github.com/Azure/azure-data-lake-store-python/blob/master/.github/breaking-changes.md)
+
+#### General guidelines
+
+The following guidelines must be followed in **EVERY** pull request that is opened.
+
+- Title of the pull request is clear and informative
+- There are a small number of commits that each have an informative message
+- A description of the changes the pull request makes is included
+- All files have the Microsoft copyright header
+- The pull request does not introduce [breaking changes](https://github.com/Azure/azure-data-lake-store-python/blob/master/.github/breaking-changes.md)
+
+#### Testing Guidelines
+
+The following guidelines must be followed in **EVERY** pull request that is opened.
+
+- Pull request includes test coverage for the included changes

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,21 @@
+### Description
+**Outline the issue here:**
+
+---
+
+### Reproduction Steps
+** Enumerate the steps to reproduce the issue here:**
+
+### Environment summary
+
+**SDK Version:** What version of the SDK  are you using? (pip show azure-datalake-store)
+Answer here:
+
+**Python Version:** What Python version are you using? Is it 64-bit or 32-bit?  
+Answer here:
+
+**OS Version:** What OS and version are you using?  
+Answer here:
+
+**Shell Type:** What shell are you using? (e.g. bash, cmd.exe, Bash on Windows)  
+Answer here:

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,11 @@
+---
+
+This checklist is used to make sure that common guidelines for a pull request are followed.
+
+### Description of the change
+
+### General Guidelines
+
+- [ ] The PR has modified HISTORY.rst with an appropriate description of the change and a version increment.
+- [ ] The PR has supporting test coverage that confirm the expected behavior and protects against regressions, including necessary recordings.
+- [ ] Links to associated bugs, if any, are in the description.

.github/breaking-changes.md

@@ -0,0 +1,26 @@
+# Breaking Change Definition
+
+Breaking changes in Azure Data Lake Store Filesystem SDK for Python are defined as follows:
+
+## Classes
+
+- The class is removed
+- The class is renamed
+- The class no longer extends another class
+
+## Properties of a class
+
+- A property is removed
+- A property is renamed
+- A property has its type changed
+
+## Methods of a class
+- Methods should not be removed
+- Methods should not be renamed
+- Methods should not have their return type changed
+
+## Parameters of methods in a class
+- Parameters should not be removed
+- Parameters should not have their type changed
+- Parameters should preserve their ordering, including when a parameter is added
+- Parameters should keep their default value, if they are assigned one