Getting things opensource-ready #8

StanleyGoldman · 2017-06-26T15:23:11Z

No description provided.

shana · 2017-06-26T17:47:10Z

CONTRIBUTING.md

@@ -0,0 +1,171 @@
+# Contributing to GitHub Desktop


GitHub for Unity

shana · 2017-06-26T17:47:19Z

CONTRIBUTING.md

+### Suggesting Enhancements
+
+This section guides you through submitting an enhancement suggestion for
+GitHub Desktop, including completely new features and minor improvements to


GitHub for Unity

shana · 2017-06-26T17:47:26Z

CONTRIBUTING.md

+* **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 Desktop users.


GitHub for Unity

shana · 2017-06-26T17:47:33Z

CONTRIBUTING.md

+  understand the enhancement from your perspective
+* **Explain why this enhancement would be useful** to GitHub Desktop users.
+* **Include screenshots and animated GIFs** if relevant to help you demonstrate
+  the steps or point out the part of GitHub Desktop which the suggestion is


GitHub for Unity

shana · 2017-06-26T17:48:02Z

README.md

+and fill out the template to provide us with enough information to investigate
+further.
+
+## How can I contribute to GitHub Desktop?


GitHub for Unity

shana · 2017-06-26T17:48:18Z

docs/process/issue-triage.md

+ - user experience - ensure things are consistent, discoverable
+ - quality - ensure the change does not adversely affect other features
+
+e.g. GitHub Desktop should support worktrees as a first class feature.


GitHub for Unity

shana · 2017-06-26T17:48:59Z

docs/process/issue-triage.md

+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.
+
+e.g. GitHub Desktop should support working with Mercurial repositories.


I would kill this example and not provide one

shana · 2017-06-26T17:49:36Z

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,74 @@
+<!--
+
+Have you read GitHub Desktop's Code of Conduct? By filing an Issue, you are


We already have a template in the github-beta repo that we can use here. The code of conduct mention is nice, if we don't have it there we should keep it here

shana · 2017-06-26T17:49:49Z

CONTRIBUTING.md

+
+### The Beta Roadmap
+
+Currently GitHub for Unity is in a public beta, and the team is focused on


shana · 2017-06-26T17:50:09Z

CONTRIBUTING.md

+
+Currently GitHub for Unity is in a public beta, and the team is focused on
+triaging reported issues and working towards a 1.0 milestone - where the
+application can be used in place of the classic Mac and Windows applications.


This sentence doesn't apply to us

shana · 2017-06-26T17:51:59Z

CONTRIBUTING.md

+This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDUCT.md).
+By participating, you are expected to uphold this code.
+###TODO: Figure out what email address to use
+Please report unacceptable behavior to [opensource+desktop@github.com](mailto:opensource+desktop@github.com).


opensource+unity@github.com, probably. Even though we have a unity@github.com, for code of conduct violations it's probably better to send it over to the open source team

@lee-dohm 👋 What are your thoughts on this?

@lee-dohm says we can use unity@github.com here

StanleyGoldman · 2017-06-26T20:03:09Z

README.md

-[Contributing](docs/contributing/readme.md)
+## Where can I get it?
+
+### TODO: Add more information


What do we want to say about where to get builds?

lee-dohm · 2017-06-26T20:06:48Z

.github/ISSUE_TEMPLATE.md

+### Prerequisites
+
+<!-- {{Insert any prerequisites}} -->
+


If you don't have any prerequisites like "Read the debugging documentation" or "Run Atom in Safe Mode", then this section can be removed.

Added some prereqs

lee-dohm · 2017-06-26T20:10:04Z

CONTRIBUTING.md

+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


Broken link ... should probably be ./.github/ISSUE_TEMPLATE.md

Links fixed

lee-dohm · 2017-06-26T20:12:32Z

CONTRIBUTING.md

+
+**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
+:thumbsup: to the issue to indicate this is also an issue for you, and add a


I would add a link to the reactions documentation here to help indicate that you're looking for people to use the reactions feature instead of commenting with a +1.

👍

was the correct response

lee-dohm · 2017-06-26T20:16:23Z

README.md

+Invertocat designs that include "logo" in the file title in the following
+folder: [logos](app/static/logos).
+
+### Copyright


We probably shouldn't have a copyright section since we have a license section already.

lee-dohm · 2017-06-26T20:18:58Z

Are the submodule changes intended to be part of this PR?

StanleyGoldman · 2017-06-26T20:35:14Z

Good catch @lee-dohm. I forced push without the submodule changes.

shana · 2017-06-26T20:43:26Z

CONTRIBUTING.md

+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 beta, so everything is likely to


public alpha

shana · 2017-06-26T20:44:03Z

CONTRIBUTING.md

+
+[What should I know before I get started?](#what-should-i-know-before-i-get-started)
+  * [Code of Conduct](#code-of-conduct)
+  * [The Beta Roadmap](#the-beta-roadmap)


The roadmap

shana · 2017-06-26T20:44:23Z

CONTRIBUTING.md

+By participating, you are expected to uphold this code.
+Please report unacceptable behavior to [unity@github.com](mailto:unity@github.com).
+
+### The Beta Roadmap


The Roadmap

shana · 2017-06-26T20:51:36Z

README.md

+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.


Our label is called help wanted. We should either rename the label or change this text

Renamed the label help-wanted to up-for-grabs

shana · 2017-06-26T20:52:00Z

CONTRIBUTING.md

+ - 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)


Our label is called help wanted. We can either rename the label or change this text

Renamed the label help-wanted to up-for-grabs

shana · 2017-06-26T20:52:21Z

CONTRIBUTING.md

+
+| Label name | :mag_right: | Description |
+| --- | --- | --- |
+| `up-for-grabs` | [search](https://github.com/desktop/desktop/labels/up-for-grabs)  | Issues marked as ideal for external contributors. |


See above about help wanted

Renamed the label help-wanted to up-for-grabs

shana · 2017-06-26T20:53:17Z

CONTRIBUTING.md

+| `enhancement` | [search](https://github.com/desktop/desktop/labels/enhancement) | Feature requests. |
+| `bug` | [search](https://github.com/desktop/desktop/labels/bug)  | Confirmed bugs or reports that are very likely to be bugs. |
+| `question` | [search](https://github.com/desktop/desktop/labels/question)  | Questions more than bug reports or feature requests (e.g. how do I do X). |
+| `more-information-needed` | [search](https://github.com/desktop/desktop/labels/more-information-needed) | More information needs to be collected about these problems or feature requests (e.g. steps to reproduce). |


We don't have this label. We can rename the needs investigation label to more-information-needed, it's a better name.

Renamed the label needs-investigation to more-information-needed

shana · 2017-06-26T20:53:31Z

CONTRIBUTING.md

+| `bug` | [search](https://github.com/desktop/desktop/labels/bug)  | Confirmed bugs or reports that are very likely to be bugs. |
+| `question` | [search](https://github.com/desktop/desktop/labels/question)  | Questions more than bug reports or feature requests (e.g. how do I do X). |
+| `more-information-needed` | [search](https://github.com/desktop/desktop/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/desktop/desktop/labels/needs-reproduction)  | Likely bugs, but haven't been reliably reproduced. |


Our label is called needs-repro

Renamed the label to needs-reproduction

shana · 2017-06-26T20:53:43Z

CONTRIBUTING.md

+| `more-information-needed` | [search](https://github.com/desktop/desktop/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/desktop/desktop/labels/needs-reproduction)  | Likely bugs, but haven't been reliably reproduced. |
+| `macOS` | [search](https://github.com/desktop/desktop/labels/macOS)  | Issues specific to macOS users. |
+| `Windows` | [search](https://github.com/desktop/desktop/labels/Windows)  | Issues specific to Windows users. |


Need to create these labels.

Created the labels, also added an additional linux label

shana · 2017-06-26T20:54:14Z

CONTRIBUTING.md

+This section lists the labels we use to help us track and manage issues and
+pull requests.
+
+#### Type of Issue and Issue State


All the label links on this document are pointing to desktop/desktop

Doh. Fixed.

shana · 2017-06-26T20:57:04Z

docs/process/issue-triage.md

+ - 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


These labels should match what we have

The labels were renamed in the project to match

shana · 2017-06-26T20:59:15Z

docs/process/issue-triage.md

+ - user experience - ensure things are consistent, discoverable
+ - quality - ensure the change does not adversely affect other features
+
+e.g. GitHub for Unity should support worktrees as a first class feature.


This line is a bit out of place here. I don't think we need it, what do you think?

Yea, it's weird, taking it out.

shana · 2017-06-26T20:59:48Z

docs/process/issue-triage.md

+
+e.g. GitHub for Unity should support worktrees as a first class feature.
+
+For work that we may evaluate post-1.0, we will label the issue `future-work`


This label doesn't exist, we should probably create it.

Label created

StanleyGoldman requested a review from shana June 26, 2017 15:23

shana reviewed Jun 26, 2017

View reviewed changes

CONTRIBUTING.md Outdated

@@ -0,0 +1,171 @@

# Contributing to GitHub Desktop

Copy link

Member

shana Jun 26, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

GitHub for Unity

shana reviewed Jun 26, 2017

View reviewed changes

shana suggested changes Jun 26, 2017

View reviewed changes

StanleyGoldman force-pushed the fixes/open-source-ready branch 6 times, most recently from bc557fd to 25b4c72 Compare June 26, 2017 18:47

StanleyGoldman commented Jun 26, 2017

View reviewed changes

lee-dohm reviewed Jun 26, 2017

View reviewed changes

StanleyGoldman added 12 commits June 26, 2017 16:33

Adding documentation based on GitHub Desktop

cff0c47

Adding link to releases

e6a97b2

Updating readme

3b05207

Adding an initial setup.md

1cc50b7

Updating styleguid

2a2a265

Adding blank tooling file

1f0937f

Adding blank troubleshooting.md

062c621

Removing link to release upddates

04454c8

Adding some prerequisites to ISSUE_TEMPLATE

ad84cdb

Updating links

641359e

Adding link to reaction documentation

63fe737

Removing copyright section

f9403aa

StanleyGoldman force-pushed the fixes/open-source-ready branch from a617268 to f9403aa Compare June 26, 2017 20:34

shana reviewed Jun 26, 2017

View reviewed changes

Fixing release version information

99d2ca7

shana reviewed Jun 26, 2017

View reviewed changes

StanleyGoldman and others added 7 commits June 27, 2017 08:41

Clearing roadmap.md

8bf35f9

Adding a link to the Linux issue label

083d353

Fixing links

72dd0e0

Removing text

e55d78d

Update how-to-build.md

7cfa508

Update how-to-build.md

6f6b6f0

Update instructions with more detail

cff4c5b

StanleyGoldman added the ready-for-review label Jun 27, 2017

shana changed the title ~~Adding documentation based on GitHub Desktop~~ Adding documentation Jun 27, 2017

shana changed the title ~~Adding documentation~~ Getting things opensource-ready Jun 27, 2017

shana approved these changes Jun 27, 2017

View reviewed changes

shana merged commit c0902b4 into master Jun 27, 2017

shana deleted the fixes/open-source-ready branch June 27, 2017 21:50

		@@ -0,0 +1,74 @@
		<!--

		Have you read GitHub Desktop's Code of Conduct? By filing an Issue, you are


		### The Beta Roadmap

		Currently GitHub for Unity is in a public beta, and the team is focused on


		e.g. GitHub for Unity should support worktrees as a first class feature.

		For work that we may evaluate post-1.0, we will label the issue `future-work`

Getting things opensource-ready #8

Getting things opensource-ready #8

Uh oh!

Conversation

StanleyGoldman commented Jun 26, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lee-dohm commented Jun 26, 2017

Uh oh!

StanleyGoldman commented Jun 26, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!