diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 000000000..3b7df1cb5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,32 @@ + + +### 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 + + + +### 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. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..cdaa94a86 --- /dev/null +++ b/.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 + + + +### Alternate Designs + + + +### Benefits + + + +### Possible Drawbacks + + + +### Applicable Issues + + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..e69f822e9 --- /dev/null +++ b/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 [unity@github.com](mailto:unity@github.com). + +### 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. | diff --git a/README.md b/README.md index 1a948e6a6..f8e117320 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,59 @@ -# 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) +![GitHub for Unity screenshot](https://unity.github.com/assets/unity-screenshot.png) -[Contributing](docs/contributing/readme.md) +## Where can I get it? + +[Releases](https://github.com/github-for-unity/Unity/releases) + +## Installing GitHub for Unity + +### Requirements + +- [Unity 5.4 or higher](https://store.unity.com/download). Personal edition is fine. + +### Installation + +- Create a new Unity project. +- Download the latest release from the [releases page](https://github.com/github/UnityInternal/releases) and double-click the unitypackage file. The package will install itself into the project currently opened in Unity, and Unity will automatically load it once all the files are in the project. + +## 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. diff --git a/docs/contributing/how-to-build.md b/docs/contributing/how-to-build.md index 088d8a36f..578a422e6 100644 --- a/docs/contributing/how-to-build.md +++ b/docs/contributing/how-to-build.md @@ -1,18 +1,56 @@ # Contributing to GitHub for Unity ## Build Requirements -To build GitHub for Unity we recommend using Visual Studio 2015 or Mono 4.x and bash. + +This repository is LFS-enabled. To clone it, you should use a git client that supports git LFS 2.x and submodules. + +### Windows + +- Visual Studio 2015+ or Mono 4.x + bash shell (git bash). Mono 5.x will not work +- `UnityEngine.dll` and `UnityEditor.dll`. + - If you've installed Unity in the default location of `C:\Program Files\Unity` or `C:\Program Files (x86)\Unity`, the build will be able to reference these DLLs automatically. Otherwise, you'll need to copy these DLLs from your Unity installation into the `lib` directory in order for the build to work + +### MacOS + +- Mono 4.x. Mono 5.x will likely not work +- `UnityEngine.dll` and `UnityEditor.dll`. + - If you've installed Unity in the default location of `/Applications/Unity`, the build will be able to reference these DLLs automatically. Otherwise, you'll need to copy these DLLs from your Unity installation into the `lib` directory in order for the build to work + +## Solution organization + +The `GitHub.Unity.sln` solution includes several projects: + +- dotnet-httpclient35 and octokit: external dependencies for threading and github api support, respectively. These are the submodules. +- packaging: empty projects with build rules that copy DLLs to various locations for testing +- Tests: unit and integration test projects +- GitHub.Logging: A logging helper library +- GitHub.Api: The core of the extension. This project is C#6 and includes async/await threading and other features that Unity cannot currently compile. +- GitHub.Unity: Unity-specific code. This project is compilable by Unity ## How to Build - + +Clone the repository and its submodules in a git GUI client that supports Git LFS or via the command line with the following commands + +``` +git lfs clone https://github.com/github-for-unity/Unity +cd Unity +git submodule init +git submodule deinit script +git submodule update +``` + ### Visual Studio To build with Visual Studio 2015 open the solution file `GitHub.Unity.sln`. Select `Build Solution` in the `Build` menu. -### Mono and Bash +### Mono and Bash (windows and mac) To build with Mono 4.x and Bash execute `build.sh` in a bash shell. ## Build Output -Building the project creates an output folder named `github-unity-test` that is a sibling to the cloned repository. For instance, if the solution is located at `c:\Projects\Unity` the test output can be foud at `c:\Projects\github-unity-test`. The output folder contains a blank Unity project folder named `GitHubExtensionProject`. This folder is a blank Unity 5.5 project with GitHub for Unity installed. \ No newline at end of file +Once you've built the solution for the first time, you can open `src/UnityExtension/Assets/Editor/GitHub.Unity` in Unity. This folder contains the `GitHub.Unity` project and all the Unity UI and other Unity-specific code that you can have Unity compile as normal for quick testing and prototyping. + +The build also creates a Unity test project called `GitHubExtension` inside a directory called `github-unity-test` next to your local clone. For instance, if the repository is located at `c:\Projects\Unity` the test project will be at `c:\Projects\github-unity-test\GitHubExtension`. You can use this project to test binary builds of the extension in a clean environment (all needed DLLs will be copied to it every time you build). + +Note: some files might be locked by Unity if have one of the build output projects open when you compile from VS or the command line. This is expected and shouldn't cause issues with your builds. diff --git a/docs/contributing/setup.md b/docs/contributing/setup.md new file mode 100644 index 000000000..ec3c5fa1b --- /dev/null +++ b/docs/contributing/setup.md @@ -0,0 +1,26 @@ +# Development Environment Setup + +## Setup + +You will need to install these tools on your machine: + +### macOS + +### Windows + +## Verification + +## Building GitHub for Unity + +## Running tests + +## Debugging + +## The Next Steps + +You're almost there! Here's a couple of things we recommend you read next: + + - [Up for Grabs](../../CONTRIBUTING.md#up-for-grabs) - we've marked some tasks in + the backlog that are ideal for external contributors + - [Code Reviews](../process/reviews.md) - some notes on how the team does + code reviews diff --git a/docs/contributing/coding-conventions.md b/docs/contributing/styleguide.md similarity index 85% rename from docs/contributing/coding-conventions.md rename to docs/contributing/styleguide.md index e9b492888..a2978624d 100644 --- a/docs/contributing/coding-conventions.md +++ b/docs/contributing/styleguide.md @@ -1,6 +1,6 @@ # Contributing to GitHub for Unity -## Coding Conventions +## Style Guide - PascalCase for all types regardless of visibility - PascalCase for public members and const members - camelCase for private members, parameters and variables @@ -9,4 +9,4 @@ - Space before `()` in `if`, `for`, `while` - Space before `{` - Spaces inside `{ }` when on the same line - `{ get; set; }` -- Spaces after any `;` if statements follow it \ No newline at end of file +- Spaces after any `;` if statements follow it diff --git a/docs/contributing/tooling.md b/docs/contributing/tooling.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/contributing/troubleshooting.md b/docs/contributing/troubleshooting.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/features.md b/docs/features.md deleted file mode 100644 index b22631697..000000000 --- a/docs/features.md +++ /dev/null @@ -1 +0,0 @@ -# Features \ No newline at end of file diff --git a/docs/install.md b/docs/install.md deleted file mode 100644 index 7245bc582..000000000 --- a/docs/install.md +++ /dev/null @@ -1,10 +0,0 @@ -# Installing GitHub for Unity - -## Requirements - -- [Unity 5.4 or higher](https://store.unity.com/download). Personal edition is fine. - -## Installation - -- Create a new Unity project. -- Download the latest release from the [releases page](https://github.com/github/UnityInternal/releases) and double-click the unitypackage file. The package will install itself into the project currently opened in Unity, and Unity will automatically load it once all the files are in the project. \ No newline at end of file diff --git a/docs/known-issues.md b/docs/known-issues.md deleted file mode 100644 index 42f072604..000000000 --- a/docs/known-issues.md +++ /dev/null @@ -1,9 +0,0 @@ -# Known Issues - -- Authentication is not plugged in to git yet, so push/pull doesn't work -- lfs locking is not plugged in yet -- Branches list sometimes doesn't show all branches -- Settings view is under construction -- Resizing the history view into wide-mode isn't working right -- Scrolling the changes view hides UI elements that should be always visible (the commit box, the top bar) -- Initializing the project as a git repo is not plugged in yet diff --git a/docs/process/issue-triage.md b/docs/process/issue-triage.md new file mode 100644 index 000000000..853e7c78c --- /dev/null +++ b/docs/process/issue-triage.md @@ -0,0 +1,44 @@ +# Issue Triage + +Incoming issues should be grouped into one of these buckets: + +## Bugs + +These are problems with the current app that are identified by users. These +should be reviewed to ensure they: + + - specify the build associated with the issue + - have instructions sufficient to reproduce the issue + - have details about the impact and severity of the issue + +We will use the `more-information-needed` and `reproduction-required` labels to +indicate when issues are incomplete. + +Once enough detail has been captured about the issue, and it can be reproduced +by one of the maintainers, these should be prioritized by the team. Severe bugs +or bugs affecting many users would be prioritized above minor or low impact +bugs. + +## Enhancements + +Changes or improvements to existing features of the application are generally +fine, but should have some review process before they are implemented. +Contributors are encouraged to open issues to discuss enhancements so that other +contributors can see and participate in the discussion, and the core team can +remain transparent about the interactions. + +To ensure the quality of the application remains high over time, the core team +may need to work with the user proposing the change to clarify details before +work should proceed: + + - user interface - appropriate use of styles, layout + - user experience - ensure things are consistent, discoverable + - quality - ensure the change does not adversely affect other features + +For work that we may evaluate post-1.0, we will label the issue `future-work` +and close it out, to keep our short-term backlog under control. + +## Out-of-scope + +We anticipate ideas or suggestions that don't align with how we see the +application evolving, so we may close issues with an explanation of why. diff --git a/docs/process/reviews.md b/docs/process/reviews.md new file mode 100644 index 000000000..bac857303 --- /dev/null +++ b/docs/process/reviews.md @@ -0,0 +1,93 @@ +# The Review Process + +This is the typical flow: + +1. **Contributor** opens pull request. +1. When it's ready for review, they comment on it saying so. +1. A member of the maintainer team will give it a quick look over and + add the `ready-for-review` label. +1. Suddenly a wild **reviewer** appears! +1. **Reviewer** assigns the PR to themselves. +1. **Reviewer** leaves line comments with suggestions or questions. +1. When the **reviewer** is done they comment on the PR with an emoji, meme, + pokémon, or words to that effect. +1. The **contributor** responds to feedback, makes changes, etc. +1. When the **contributor** is ready for the **reviewer** to re-review, they + comment on the PR with an emoji, meme, pokémon or words to that effect. +1. Goto 6 until both parties are happy with the PR. +1. The **reviewer** hits the big green merge button and deletes the branch (if + applicable). + +The rest of this document goes into more details around this flow. + +## Notes for Contributors + +### Work-in-Progress + +We recommend open pull requests early - ideally as soon as you have something to +show. This is especially helpful for large pieces of work, as continuous +integration tests are run earlier on, and regressions can be caught before +humans get involved. + +Until the code is ready for review, you can prefix the PR title with [WIP] to +indicate that it's under development. + +### Use Task Lists + +If you are working through a list of tasks as part of a pull request, listing +those tasks and indicating when they have been completed helps reviewers to +understand quickly what's changed. + +### Keep The Commit History Tidy + +We're not that fussy about the history, but to make reviewing easier here's +some general tips: + + - make small, meaningful and logical commits - these make the review process easier + - [write good commit messages](https://chris.beams.io/posts/git-commit/) - + these help the reviewer to understand the changes + - keep up to date with `master` - not only does this address potential merge + conflicts, it ensures you're integrating with the latest code + +When merging, we prefer you merge `master` into your branch, but for small +PRs a rebase is fine. + +### At Least One Assignee + +While many people can be involved with a review, there's generally one person +who eventually approves the pull request and merges. They'll be assigned to the +pull request early on, so we can easily verify every active pull request has a +reviewer. + +### When The Review Is Done + +We're using GitHub's review tools to co-ordinate feedback, and we like to be +methodical with our reviews, so you'll probably end up with one of two results: + + - **Approved**: nothing else to do; the reviewer merges + - **Request Changes**: there are things to address; reviewer provides details + +Reviews can take a few iterations, especially for large contributions. Don't +be disheartened if you feel it takes time - we just want to ensure each +contribution is high-quality and that any outstanding questions are resolved, +captured or documented for posterity. + +### These Things Take Time + +Our team is distributed around the world, and often we like to get their +feedback for specific areas. And even with minor changes, we often like to let +them sit for a while and give everyone a chance to provide their input. + +## Other Rules + +## No Self-Merges + +Even for minor changes, we discourage people from merging their own pull +requests. + +## Everyone Reviews + +While everyone has their own domain expertise around the codebase, we encourage +people to share the load of reviews and reviewing areas of the codebase that +aren't as familiar. This spreads knowledge across the team + diff --git a/docs/process/roadmap.md b/docs/process/roadmap.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/readme.md b/docs/readme.md index 33d7d33f7..91f17ab28 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -1,10 +1,33 @@ # GitHub for Unity Documentation -[Install](install.md) +This is the [GitHub for Unity](https://github.com/github-for-unity/Unity) development +documentation. -[Features](features.md) +## Contributing -[Known Issues](known-issues.md) +If you are interested in contributing to the project, you should read these +resources to get familiar with how things work: -[Contributing](contributing/install.md) + - **[How Can I Contribute?](../CONTRIBUTING.md#how-can-i-contribute)** - + details about how you can participate + - **[Development Environment Setup](contributing/setup.md)** - everything + you need to know to get Desktop up and running + - **[Style Guide](contributing/styleguide.md)** - notes on the coding style + - **[Tooling](contributing/tooling.md)** - if you have a preferred IDE, + there's some enhancements to make your life easier + - **[Troubleshooting](contributing/troubleshooting.md)** - some additional + known issues if you're having environment issues +## Process + +Details about how the team is organizing and shipping GitHub for Unity: + + - **[Issue Triage](process/issue-triage.md)** - how we address issues reported + by users + - **[Review Process](process/reviews.md)** - how we review contributions + - **[Roadmap](process/roadmap.md)** - how we plan for the future + +## Technical + +These documents contain more details about the internals of GitHub for Unity +and how things work: