|
| 1 | +# Contributing to GitHub for Unity |
| 2 | + |
| 3 | +:+1: :tada: :sparkling_heart: Thanks for your interest! :sparkling_heart: :tada: :+1: |
| 4 | + |
| 5 | +The following is a set of guidelines for contributing to GitHub for Unity and its |
| 6 | +related projects, which are hosted in the [GitHub for Unity Organization](https://github.com/github-for-unity) |
| 7 | +on GitHub. These are just guidelines, not rules. Use your best judgment, and |
| 8 | +feel free to propose changes to this document in a pull request. |
| 9 | + |
| 10 | +Note that GitHub for Unity is currently a public alpha, so everything is likely to |
| 11 | +change over time as we learn and refine how we work with the community. |
| 12 | + |
| 13 | +#### Table Of Contents |
| 14 | + |
| 15 | +[What should I know before I get started?](#what-should-i-know-before-i-get-started) |
| 16 | + * [Code of Conduct](#code-of-conduct) |
| 17 | + * [The Roadmap](#the-roadmap) |
| 18 | + |
| 19 | +[How Can I Contribute?](#how-can-i-contribute) |
| 20 | + * [How to Build](#how-to-build) |
| 21 | + * [Reporting Bugs](#reporting-bugs) |
| 22 | + * [Suggesting Enhancements](#suggesting-enhancements) |
| 23 | + * [Up for Grabs](#up-for-grabs) |
| 24 | + |
| 25 | +[Additional Notes](#additional-notes) |
| 26 | + * [Issue and Pull Request Labels](#issue-and-pull-request-labels) |
| 27 | + |
| 28 | +## What should I know before I get started? |
| 29 | + |
| 30 | +### Code of Conduct |
| 31 | + |
| 32 | +This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDUCT.md). |
| 33 | +By participating, you are expected to uphold this code. |
| 34 | +Please report unacceptable behavior to [[email protected]](mailto:[email protected]). |
| 35 | + |
| 36 | +### The Roadmap |
| 37 | + |
| 38 | +Currently GitHub for Unity is in a public alpha, and the team is focused on |
| 39 | +triaging reported issues and working towards a 1.0 milestone. |
| 40 | +You can follow this progress under the [Milestones](https://github.com/github-for-unity/Unity/milestones) |
| 41 | +tab. |
| 42 | + |
| 43 | +We're still thinking about where we want to take GitHub for Unity after we reach |
| 44 | +this 1.0 milestone. If you have ideas or suggestions please read the [Suggesting Enhancements](#suggesting-enhancements) |
| 45 | +section below to understand how to contribute your feedback. |
| 46 | + |
| 47 | +## How Can I Contribute? |
| 48 | + |
| 49 | +### How to Build |
| 50 | + |
| 51 | +This repository is LFS-enabled. To clone it, you should use a git client that supports git LFS 2.x and submodules. |
| 52 | + |
| 53 | +Please read the [How to Build](https://raw.githubusercontent.com/github-for-unity/Unity/master/docs/contributing/how-to-build.md) document for information on how to build GitHub for Unity. |
| 54 | + |
| 55 | +### Reporting Bugs |
| 56 | + |
| 57 | +This section guides you through submitting a bug report for GitHub for Unity. |
| 58 | +Following these guidelines helps maintainers and the community understand your |
| 59 | +report :pencil:, reproduce the behavior :computer: :computer:, and find related |
| 60 | +reports :mag_right:. |
| 61 | + |
| 62 | +Before creating bug reports, please check [this list](#before-submitting-a-bug-report) |
| 63 | +as you might find out that you don't need to create one. When you are creating |
| 64 | +a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report). |
| 65 | +Fill out [the required template](./.github/ISSUE_TEMPLATE.md), the information |
| 66 | +it asks for helps us resolve issues faster. |
| 67 | + |
| 68 | +#### Before Submitting A Bug Report |
| 69 | + |
| 70 | +**Perform a [cursory search](https://github.com/github-for-unity/Unity/labels/bug)** |
| 71 | +to see if the problem has already been reported. If it does exist, add a |
| 72 | +[reaction](https://help.github.com/articles/about-discussions-in-issues-and-pull-requests/#reacting-to-ideas-in-issues-and-pull-requests) |
| 73 | +to the issue to indicate this is also an issue for you, and add a |
| 74 | +comment to the existing issue if there is extra information you can contribute. |
| 75 | + |
| 76 | +#### How Do I Submit A (Good) Bug Report? |
| 77 | + |
| 78 | +Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). |
| 79 | + |
| 80 | +Simply create an issue on the [GitHub for Unity issue tracker](https://github.com/github-for-unity/Unity/issues) |
| 81 | +and fill out the provided [issue template](./.github/ISSUE_TEMPLATE.md). |
| 82 | + |
| 83 | +The information we are interested in includes: |
| 84 | + |
| 85 | + - details about your environment - which build, which operating system |
| 86 | + - details about reproducing the issue - what steps to take, what happens, how |
| 87 | + often it happens |
| 88 | + - other relevant information - log files, screenshots, etc. |
| 89 | + |
| 90 | +### Suggesting Enhancements |
| 91 | + |
| 92 | +This section guides you through submitting an enhancement suggestion for |
| 93 | +GitHub for Unity, including completely new features and minor improvements to |
| 94 | +existing functionality. Following these guidelines helps maintainers and the |
| 95 | +community understand your suggestion :pencil: and find related suggestions |
| 96 | +:mag_right:. |
| 97 | + |
| 98 | +Before creating enhancement suggestions, please check [this list](#before-submitting-an-enhancement-suggestion) |
| 99 | +as you might find out that you don't need to create one. When you are creating |
| 100 | +an enhancement suggestion, please [include as many details as possible](#how-do-i-submit-a-good-enhancement-suggestion). |
| 101 | +Fill in [the template](./.github/ISSUE_TEMPLATE.md), including the steps |
| 102 | +that you imagine you would take if the feature you're requesting existed. |
| 103 | + |
| 104 | +#### Before Submitting An Enhancement Suggestion |
| 105 | + |
| 106 | +**Perform a [cursory search](https://github.com/github-for-unity/Unity/labels/enhancement)** |
| 107 | +to see if the enhancement has already been suggested. If it has, add a |
| 108 | +:thumbsup: to indicate your interest in it, or comment if there is additional |
| 109 | +information you would like to add. |
| 110 | + |
| 111 | +#### How Do I Submit A (Good) Enhancement Suggestion? |
| 112 | + |
| 113 | +Enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/). |
| 114 | + |
| 115 | +Simply create an issue on the [GitHub for Unity issue tracker](https://github.com/github-for-unity/Unity/issues) |
| 116 | +and provide the following information: |
| 117 | + |
| 118 | +* **Use a clear and descriptive title** for the issue to identify the |
| 119 | + suggestion. |
| 120 | +* **Provide a step-by-step description of the suggested enhancement** in as |
| 121 | + much detail as possible. This additional context helps the maintainers to |
| 122 | + understand the enhancement from your perspective |
| 123 | +* **Explain why this enhancement would be useful** to GitHub for Unity users. |
| 124 | +* **Include screenshots and animated GIFs** if relevant to help you demonstrate |
| 125 | + the steps or point out the part of GitHub for Unity which the suggestion is |
| 126 | + related to. You can use [this tool](http://www.cockos.com/licecap/) to record |
| 127 | + GIFs on macOS and Windows. |
| 128 | +* **List some other applications where this enhancement exists, if applicable.** |
| 129 | + |
| 130 | +### Up For Grabs |
| 131 | + |
| 132 | +As the team is working towards the 1.0 release, we'll identify enhancements or |
| 133 | +bugs that can be categorized as tasks that: |
| 134 | + |
| 135 | + - have low impact, or have a known workaround |
| 136 | + - should be fixed |
| 137 | + - have a narrow scope and/or easy reproduction steps |
| 138 | + - can be worked on independent of other tasks |
| 139 | + |
| 140 | +These issues will be labelled as [`up-for-grabs`](https://github.com/github-for-unity/Unity/labels/up-for-grabs) |
| 141 | +in the repository. If you are interested in contributing to the project, please |
| 142 | +comment on the issue to let the maintainers (and community) know you are |
| 143 | +interested in picking this up. |
| 144 | + |
| 145 | +## Additional Notes |
| 146 | + |
| 147 | +### Issue and Pull Request Labels |
| 148 | + |
| 149 | +This section lists the labels we use to help us track and manage issues and |
| 150 | +pull requests. |
| 151 | + |
| 152 | +#### Type of Issue and Issue State |
| 153 | + |
| 154 | +| Label name | :mag_right: | Description | |
| 155 | +| --- | --- | --- | |
| 156 | +| `enhancement` | [search](https://github.com/github-for-unity/Unity/labels/enhancement) | Feature requests. | |
| 157 | +| `bug` | [search](https://github.com/github-for-unity/Unity/labels/bug) | Confirmed bugs or reports that are very likely to be bugs. | |
| 158 | +| `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). | |
| 159 | +| `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). | |
| 160 | +| `needs-reproduction` | [search](https://github.com/github-for-unity/Unity/labels/needs-reproduction) | Likely bugs, but haven't been reliably reproduced. | |
| 161 | +| `macOS` | [search](https://github.com/github-for-unity/Unity/labels/macOS) | Issues specific to macOS users. | |
| 162 | +| `Windows` | [search](https://github.com/github-for-unity/Unity/labels/Windows) | Issues specific to Windows users. | |
| 163 | +| `Linux` | [search](https://github.com/github-for-unity/Unity/labels/Linux) | Issues specific to Linux users. | |
| 164 | + |
| 165 | +#### Topics |
| 166 | + |
| 167 | +| Label name | :mag_right: | Description | |
| 168 | +| --- | --- | --- | |
| 169 | +| `up-for-grabs` | [search](https://github.com/github-for-unity/Unity/labels/up-for-grabs) | Issues marked as ideal for external contributors. | |
| 170 | +| `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. | |
| 171 | +| `tech-debt` | [search](https://github.com/github-for-unity/Unity/labels/tech-debt) | Issues related to code or architecture decisions. | |
| 172 | +| `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. | |
| 173 | + |
| 174 | +#### Workflow |
| 175 | + |
| 176 | +| Label name | :mag_right: | Description | |
| 177 | +| --- | --- | --- | |
| 178 | +| `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. | |
0 commit comments