Merge branch 'master' into ui/i-made-a-huge-mistake

Author: StanleyGoldman

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,32 @@
+<!--
+
+Have you read GitHub for Unity's Code of Conduct? By filing an Issue, you are expected to comply with it, including treating everyone with respect: https://github.com/github-for-unity/Unity/blob/master/CODE_OF_CONDUCT.md
+
+-->
+
+### Prerequisites
+
+- Be sure to run with tracing enabled to capture runtime details in the log file
+- Include the log file in the PR.
+  - On Windows, the extension log file is at `%LOCALAPPDATA%\GitHubUnity\github-unity.log`
+  - On macOS, the extension log file is at `~/.local/share/GitHubUnity/github-unity.log`
+
+### Description
+
+<!-- Description of the issue -->
+
+### Steps to Reproduce
+
+1. [First Step]
+2. [Second Step]
+3. [and so on...]
+
+**Expected behavior:** [What you expect to happen]
+
+**Actual behavior:** [What actually happens]
+
+**Reproduces how often:** [What percentage of the time does it reproduce?]
+
+### Additional Information
+
+Any additional information, configuration or data that might be necessary to reproduce the issue.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,28 @@
+### Requirements
+
+* Filling out the template is required. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
+* All new code requires tests to ensure against regressions
+
+### Description of the Change
+
+<!--
+
+We must be able to understand the design of your change from this description. If we can't get a good idea of what the code will be doing from the description here, the pull request may be closed at the maintainers' discretion. Keep in mind that the maintainer reviewing this PR may not be familiar with or have worked with the code here recently, so please walk us through the concepts.
+
+-->
+
+### Alternate Designs
+
+<!-- Explain what other alternates were considered and why the proposed version was selected -->
+
+### Benefits
+
+<!-- What benefits will be realized by the code change? -->
+
+### Possible Drawbacks
+
+<!-- What are the possible side-effects or negative impacts of the code change? -->
+
+### Applicable Issues
+
+<!-- Enter any applicable Issues here -->

CONTRIBUTING.md

@@ -0,0 +1,171 @@
+# Contributing to GitHub for Unity
+
+:+1: :tada: :sparkling_heart: Thanks for your interest! :sparkling_heart: :tada: :+1:
+
+The following is a set of guidelines for contributing to GitHub for Unity and its
+related projects, which are hosted in the [GitHub for Unity Organization](https://github.com/github-for-unity)
+on GitHub. These are just guidelines, not rules. Use your best judgment, and
+feel free to propose changes to this document in a pull request.
+
+Note that GitHub for Unity is currently a public alpha, so everything is likely to
+change over time as we learn and refine how we work with the community.
+
+#### Table Of Contents
+
+[What should I know before I get started?](#what-should-i-know-before-i-get-started)
+  * [Code of Conduct](#code-of-conduct)
+  * [The Roadmap](#the-roadmap)
+
+[How Can I Contribute?](#how-can-i-contribute)
+  * [Reporting Bugs](#reporting-bugs)
+  * [Suggesting Enhancements](#suggesting-enhancements)
+  * [Up for Grabs](#up-for-grabs)
+
+[Additional Notes](#additional-notes)
+  * [Issue and Pull Request Labels](#issue-and-pull-request-labels)
+
+## What should I know before I get started?
+
+### Code of Conduct
+
+This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDUCT.md).
+By participating, you are expected to uphold this code.
+Please report unacceptable behavior to [[email protected]](mailto:[email protected]).
+
+### The Roadmap
+
+Currently GitHub for Unity is in a public alpha, and the team is focused on
+triaging reported issues and working towards a 1.0 milestone.
+You can follow this progress under the [Milestones](https://github.com/github-for-unity/Unity/milestones)
+tab.
+
+We're still thinking about where we want to take GitHub for Unity after we reach
+this 1.0 milestone. If you have ideas or suggestions please read the [Suggesting Enhancements](#suggesting-enhancements)
+section below to understand how to contribute your feedback.
+
+## How Can I Contribute?
+
+### Reporting Bugs
+
+This section guides you through submitting a bug report for GitHub for Unity.
+Following these guidelines helps maintainers and the community understand your
+report :pencil:, reproduce the behavior :computer: :computer:, and find related
+reports :mag_right:.
+
+Before creating bug reports, please check [this list](#before-submitting-a-bug-report)
+as you might find out that you don't need to create one. When you are creating
+a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report).
+Fill out [the required template](./.github/ISSUE_TEMPLATE.md), the information
+it asks for helps us resolve issues faster.
+
+#### Before Submitting A Bug Report
+
+**Perform a [cursory search](https://github.com/github-for-unity/Unity/labels/bug)**
+to see if the problem has already been reported. If it does exist, add a
+[reaction](https://help.github.com/articles/about-discussions-in-issues-and-pull-requests/#reacting-to-ideas-in-issues-and-pull-requests)
+to the issue to indicate this is also an issue for you, and add a
+comment to the existing issue if there is extra information you can contribute.
+
+#### How Do I Submit A (Good) Bug Report?
+
+Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/).
+
+Simply create an issue on the [GitHub for Unity issue tracker](https://github.com/github-for-unity/Unity/issues)
+and fill out the provided [issue template](./.github/ISSUE_TEMPLATE.md).
+
+The information we are interested in includes:
+
+ - details about your environment - which build, which operating system
+ - details about reproducing the issue - what steps to take, what happens, how
+   often it happens
+ - other relevant information - log files, screenshots, etc.
+
+### Suggesting Enhancements
+
+This section guides you through submitting an enhancement suggestion for
+GitHub for Unity, including completely new features and minor improvements to
+existing functionality. Following these guidelines helps maintainers and the
+community understand your suggestion :pencil: and find related suggestions
+:mag_right:.
+
+Before creating enhancement suggestions, please check [this list](#before-submitting-an-enhancement-suggestion)
+as you might find out that you don't need to create one. When you are creating
+an enhancement suggestion, please [include as many details as possible](#how-do-i-submit-a-good-enhancement-suggestion).
+Fill in [the template](./.github/ISSUE_TEMPLATE.md), including the steps
+that you imagine you would take if the feature you're requesting existed.
+
+#### Before Submitting An Enhancement Suggestion
+
+**Perform a [cursory search](https://github.com/github-for-unity/Unity/labels/enhancement)**
+to see if the enhancement has already been suggested. If it has, add a
+:thumbsup: to indicate your interest in it, or comment if there is additional
+information you would like to add.
+
+#### How Do I Submit A (Good) Enhancement Suggestion?
+
+Enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/).
+
+Simply create an issue on the [GitHub for Unity issue tracker](https://github.com/github-for-unity/Unity/issues)
+and provide the following information:
+
+* **Use a clear and descriptive title** for the issue to identify the
+  suggestion.
+* **Provide a step-by-step description of the suggested enhancement** in as
+  much detail as possible. This additional context helps the maintainers to
+  understand the enhancement from your perspective
+* **Explain why this enhancement would be useful** to GitHub for Unity users.
+* **Include screenshots and animated GIFs** if relevant to help you demonstrate
+  the steps or point out the part of GitHub for Unity which the suggestion is
+  related to. You can use [this tool](http://www.cockos.com/licecap/) to record
+  GIFs on macOS and Windows.
+* **List some other applications where this enhancement exists, if applicable.**
+
+### Up For Grabs
+
+As the team is working towards the 1.0 release, we'll identify enhancements or
+bugs that can be categorized as tasks that:
+
+ - have low impact, or have a known workaround
+ - should be fixed
+ - have a narrow scope and/or easy reproduction steps
+ - can be worked on independent of other tasks
+
+These issues will be labelled as [`up-for-grabs`](https://github.com/github-for-unity/Unity/labels/up-for-grabs)
+in the repository. If you are interested in contributing to the project, please
+comment on the issue to let the maintainers (and community) know you are
+interested in picking this up.
+
+## Additional Notes
+
+### Issue and Pull Request Labels
+
+This section lists the labels we use to help us track and manage issues and
+pull requests.
+
+#### Type of Issue and Issue State
+
+| Label name | :mag_right: | Description |
+| --- | --- | --- |
+| `enhancement` | [search](https://github.com/github-for-unity/Unity/labels/enhancement) | Feature requests. |
+| `bug` | [search](https://github.com/github-for-unity/Unity/labels/bug)  | Confirmed bugs or reports that are very likely to be bugs. |
+| `question` | [search](https://github.com/github-for-unity/Unity/labels/question)  | Questions more than bug reports or feature requests (e.g. how do I do X). |
+| `more-information-needed` | [search](https://github.com/github-for-unity/Unity/labels/more-information-needed) | More information needs to be collected about these problems or feature requests (e.g. steps to reproduce). |
+| `needs-reproduction` | [search](https://github.com/github-for-unity/Unity/labels/needs-reproduction)  | Likely bugs, but haven't been reliably reproduced. |
+| `macOS` | [search](https://github.com/github-for-unity/Unity/labels/macOS)  | Issues specific to macOS users. |
+| `Windows` | [search](https://github.com/github-for-unity/Unity/labels/Windows)  | Issues specific to Windows users. |
+| `Linux` | [search](https://github.com/github-for-unity/Unity/labels/Linux)  | Issues specific to Linux users. |
+
+#### Topics
+
+| Label name | :mag_right: | Description |
+| --- | --- | --- |
+| `up-for-grabs` | [search](https://github.com/github-for-unity/Unity/labels/up-for-grabs)  | Issues marked as ideal for external contributors. |
+| `polish` | [search](https://github.com/github-for-unity/Unity/labels/polish) | Issues not critical to the application but would provide a better experience if resolved. |
+| `tech-debt` | [search](https://github.com/github-for-unity/Unity/labels/tech-debt) | Issues related to code or architecture decisions. |
+| `design` | [search](https://github.com/github-for-unity/Unity/labels/design)  | Issues that require some design input from the maintainers as part of completing the work. |
+
+#### Workflow
+
+| Label name | :mag_right: | Description |
+| --- | --- | --- |
+| `ready-for-review` | [search](https://github.com/github-for-unity/Unity/labels/ready-for-review)  | Pull Requests that are ready to be reviewed by the maintainers. |

README.md

@@ -1,11 +1,145 @@
-# GitHub for Unity
+# [GitHub for Unity](https://unity.github.com)
 
-The GitHub for Unity extension brings Git and GitHub into Unity, integrating source control into your work with friendly and accessible tools and workflows.
+![Build Status](https://ci.appveyor.com/api/projects/status/github/github-for-unity/Unity?branch=master&svg=true)
 
-[Install](docs/install.md)
+[![Join the chat at https://gitter.im/github/VisualStudio](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/github-for-unity/Unity?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-[Features](docs/features.md)
+The GitHub for Unity extension brings [Git](https://git-scm.com/) and GitHub into [Unity](https://unity3d.com/), integrating source control into your work with friendly and accessible tools and workflows.
 
-[Known Issues](docs/known-issues.md)
+**Please note:** this software is currently alpha quality. Please refer to the [list of known issues](https://github.com/github-for-unity/Unity/issues?q=is%3Aissue+is%3Aopen+label%3Abug), and make sure you have backups of your work before trying it out.
 
-[Contributing](docs/contributing/readme.md)
+## Installing GitHub for Unity
+
+### Requirements
+
+- [Unity 5.4 or higher](https://store.unity.com/download). Personal edition is fine.
+
+### Installation
+
+To install the extension, download the latest package from [the releases page](https://github.com/github-for-unity/Unity/releases) and double click on it.
+
+#### Opening the GitHub window
+
+You can access the GitHub window by going to Windows -> GitHub. The window opens by default next to the Inspector window.
+
+#### Initialize Repository
+
+![Initialize repository screenshot](https://user-images.githubusercontent.com/121322/27644875-7fc6302a-5bd9-11e7-98d0-c09b2e450503.png)
+
+If the current Unity project is not in a Git repository, the GitHub for Unity extension will offer to initialize the repository for you. This will:
+
+- Initialize a git repository at the Unity project root via `git init`
+- Initialize git-lfs via `git lfs install`
+- Set up a `.gitignore` file at the Unity project root.
+- Set up a `.gitattributes` file at the Unity project root with a large list of known binary filetypes (images, audio, etc) that should be tracked by LFS
+- Configure the project to serialize meta files as text
+- Create an initial commit with the `.gitignore` and `.gitattributes` file.
+
+#### Authentication
+
+To set up credentials in Git so you can push and pull, you can sign in to GitHub by going to `Window` -> `GitHub` -> `Account` -> `Sign in`. You only have to sign in successfully once, your credentials will remain on the system for all Git operations in Unity and outside of it. If you've already signed in once but the Account dropdown still says `Sign in`, ignore it, it's a bug.
+
+![Authentication screenshot](https://user-images.githubusercontent.com/121322/27644895-8f22f904-5bd9-11e7-8a93-e6bfe0c24a74.png)
+
+#### Publish a new repository
+
+1. Go to [github.com](https://github.com) and create a new empty repository - do not add a license, readme or other files during the creation process.
+2. Copy the **https** URL shown in the creation page
+3. In Unity, go to `Windows` -> `GitHub` -> `Settings` and paste the url into the `Remote` textbox.
+3. Click `Save repository`.
+4. Go to the `History` tab and click `Push`.
+
+#### Commiting your work - Changes tab
+
+You can see which files have been changed and commit them through the Changes tab. `.meta` files will show up in relation to their files on the tree, so you can select a file for comitting and automatically have their `.meta` 
+
+![Changes tab screenshot](https://user-images.githubusercontent.com/121322/27644933-ab00af72-5bd9-11e7-84c3-edec495f87f5.png)
+
+#### Pushing/pulling your work - History tab
+
+The history tab includes a `Push` button to push your work to the server. Make sure you have a remote url configured in the `Settings` tab so that you can push and pull your work.
+
+To receive updates from the server by clicking on the `Pull` button. You cannot pull if you have local changes, so commit your changes before pulling.
+
+![History tab screenshot](https://user-images.githubusercontent.com/121322/27644965-c1109bba-5bd9-11e7-9257-4fa38f5c67d1.png)
+
+#### Branches tab
+
+![Branches tab screenshot](https://user-images.githubusercontent.com/121322/27644978-cd3c5622-5bd9-11e7-9dcb-6ae5d5c7dc8a.png)
+
+#### Settings tab
+
+You can configure your user data in the Settings tab, along with the path to the Git installation.
+
+Locked files will appear in a list in the Settings tab. You can see who has locked a file and release file locks after you've pushed your work.
+
+![Settings tab screenshot](https://user-images.githubusercontent.com/121322/27644993-d9d325a0-5bd9-11e7-86f5-beee00e9e8b8.png)
+
+#### Windows
+
+The GitHub for Unity extension ships with a bundle of Git and Git LFS, to ensure that you have the correct version. These will be installed into `%LOCALAPPDATA%\GitHubUnityDebug` when the extension runs for the first time.
+
+You can open a command line with the same Git and Git LFS version that the extension uses by going to the GitHub -> Command line menu.
+
+Make sure a Git user and email address are set in the `%HOME%\.gitconfig` file before you initialize a repository for the first time. You can set these values by opening your `%HOME%\.gitconfig`  file and adding the following section, if it doesn't exist yet:
+
+```
+[user]
+	name = Your Name
+	email = Your Email
+```
+
+##### Log files
+
+The extension log file can be found at `%LOCALAPPDATA%\GitHubUnityDebug\github-unity.log`
+
+#### macOS
+
+The current release has limited macOS support. macOS users will need to install the latest [Git](https://git-scm.com/downloads) and [Git LFS](https://git-lfs.github.com/) manually, and make sure these are on the path. You can configure the Git location in the Settings tab on the GitHub window.
+
+Make sure a Git user and email address are set in the `~/.gitconfig` file before you initialize a repository for the first time. You can set these values by opening your `~/.gitconfig` file and adding the following section, if it doesn't exist yet:
+
+```
+[user]
+	name = Your Name
+	email = Your Email
+```
+
+##### Log files
+
+The extension log file can be found at `~/.local/share/GitHubUnityDebug/github-unity.log`. This is a temporary location and will be changed in the future.
+
+## I have a problem with GitHub for Unity
+
+First, please search the [open issues](https://github.com/github-for-unity/Unity/issues?q=is%3Aopen)
+and [closed issues](https://github.com/github-for-unity/Unity/issues?q=is%3Aclosed)
+to see if your issue hasn't already been reported (it may also be fixed).
+
+If you can't find an issue that matches what you're seeing, open a [new issue](https://github.com/github-for-unity/Unity/issues/new)
+and fill out the template to provide us with enough information to investigate
+further.
+
+## How can I contribute to GitHub for Unity?
+
+The [CONTRIBUTING.md](./CONTRIBUTING.md) document will help you get setup and
+familiar with the source. The [documentation](docs/) folder also contains more
+resources relevant to the project.
+
+If you're looking for something to work on, check out the [up-for-grabs](https://github.com/github-for-unity/Unity/issues?q=is%3Aopen+is%3Aissue+label%3Aup-for-grabs) label.
+
+## More Resources
+
+See [unity.github.com](https://unity.github.com) for more product-oriented
+information about GitHub for Unity.
+
+## License
+
+**[MIT](LICENSE)**
+
+The MIT license grant is not for GitHub's trademarks, which include the logo
+designs. GitHub reserves all trademark and copyright rights in and to all
+GitHub trademarks. GitHub's logos include, for instance, the stylized
+Invertocat designs that include "logo" in the file title in the following
+folder: [IconsAndLogos](https://github.com/github-for-unity/Unity/tree/master/src/UnityExtension/Assets/Editor/GitHub.Unity/IconsAndLogos).
+
+Copyright 2015 - 2017 GitHub, Inc.

common/SolutionInfo.cs

@@ -31,6 +31,6 @@
 namespace System
 {
     internal static class AssemblyVersionInformation {
-        internal const string Version = "0.11.0.0";
+        internal const string Version = "0.12.0.0";
     }
 }