Skip to content

Commit

Permalink
remove references to master in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
outofambit committed Dec 27, 2018
1 parent 3fe00ab commit d4be778
Show file tree
Hide file tree
Showing 16 changed files with 53 additions and 53 deletions.
14 changes: 7 additions & 7 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ GitHub Desktop recently announced its
[1.0 release](https://github.com/blog/2437-announcing-github-desktop-1-0) and
are working towards deprecating the classic Mac and Windows applications.

Beyond that, we are working on a roadmap you can read [here](https://github.com/desktop/desktop/blob/master/docs/process/roadmap.md).
Beyond that, we are working on a roadmap you can read [here](https://github.com/desktop/desktop/blob/development/docs/process/roadmap.md).
The immediate milestones are more detailed, and the latter milestones are more
fuzzy and subject to change.

Expand Down Expand Up @@ -139,15 +139,15 @@ interested in the issue.

### Set Up Your Machine

Start [here](https://github.com/desktop/desktop/blob/master/docs/contributing/setup.md).
Start [here](https://github.com/desktop/desktop/blob/development/docs/contributing/setup.md).


## Process Documentation

These documents are useful resources for contributors to learn more about the project and how it is run:

- [Teams](https://github.com/desktop/desktop/blob/master/docs/process/teams.md)
- [Release Planning](https://github.com/desktop/desktop/blob/master/docs/process/release-planning.md)
- [Issue Triage](https://github.com/desktop/desktop/blob/master/docs/process/issue-triage.md)
- [Issue and Pull Request Labels](https://github.com/desktop/desktop/blob/master/docs/process/labels.md)
- [Pull Request Triage](https://github.com/desktop/desktop/blob/master/docs/process/pull-request-triage.md)
- [Teams](https://github.com/desktop/desktop/blob/development/docs/process/teams.md)
- [Release Planning](https://github.com/desktop/desktop/blob/development/docs/process/release-planning.md)
- [Issue Triage](https://github.com/desktop/desktop/blob/development/docs/process/issue-triage.md)
- [Issue and Pull Request Labels](https://github.com/desktop/desktop/blob/development/docs/process/labels.md)
- [Pull Request Triage](https://github.com/desktop/desktop/blob/development/docs/process/pull-request-triage.md)
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ about: Report a problem encountered while using GitHub Desktop
First and foremost, we’d like to thank you for taking the time to contribute to our project. Before submitting your issue, please follow these steps:
1. Familiarize yourself with our contributing guide:
* https://github.com/desktop/desktop/blob/master/.github/CONTRIBUTING.md#contributing-to-github-desktop
* https://github.com/desktop/desktop/blob/development/.github/CONTRIBUTING.md#contributing-to-github-desktop
2. Check if your issue (and sometimes workaround) is in the known-issues doc:
* https://github.com/desktop/desktop/blob/master/docs/known-issues.md
* https://github.com/desktop/desktop/blob/development/docs/known-issues.md
3. Make sure your issue isn’t a duplicate of another issue
4. If you have made it to this step, go ahead and fill out the template below
-->
Expand Down Expand Up @@ -57,7 +57,7 @@ If you have screen shots or gifs that demonstrate the issue, please include them
If the issue involves a specific public repository, including the information about it will make it easier to recreate the issue.
If you are dealing with a performance issue or regression, attaching a Performance profile of the task will help the developers understand the runtime behavior of the application on your machine.
https://github.com/desktop/desktop/blob/master/docs/contributing/timeline-profile.md
https://github.com/desktop/desktop/blob/development/docs/contributing/timeline-profile.md
-->

### Logs
Expand Down
2 changes: 1 addition & 1 deletion .github/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ requestInfoReplyComment: >
Thanks for reaching out!
We require the
[template](https://github.com/desktop/desktop/blob/master/.github/CONTRIBUTING.md#how-do-i-submit-a-good-bug-report)
[template](https://github.com/desktop/desktop/blob/development/.github/CONTRIBUTING.md#how-do-i-submit-a-good-bug-report)
to be filled out with all new issues. We do this so that we can be certain we
have all the information we need to address your submission efficiently. This
allows the maintainers to spend more time fixing bugs, implementing
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

[![Travis](https://img.shields.io/travis/desktop/desktop.svg?style=flat-square&label=Travis+CI)](https://travis-ci.org/desktop/desktop)
[![CircleCI](https://img.shields.io/circleci/project/github/desktop/desktop.svg?style=flat-square&label=CircleCI)](https://circleci.com/gh/desktop/desktop)
[![AppVeyor Build Status](https://img.shields.io/appveyor/ci/github-windows/desktop/master.svg?style=flat-square&label=AppVeyor&logo=appveyor)](https://ci.appveyor.com/project/github-windows/desktop/branch/master)
[![AppVeyor Build Status](https://img.shields.io/appveyor/ci/github-windows/desktop/development.svg?style=flat-square&label=AppVeyor&logo=appveyor)](https://ci.appveyor.com/project/github-windows/desktop/branch/development)
[![Azure DevOps Pipelines Build Status](https://dev.azure.com/github/Desktop/_apis/build/status/Continuous%20Integration)](https://dev.azure.com/github/Desktop/_build/latest?definitionId=3)
[![license](https://img.shields.io/github/license/desktop/desktop.svg?style=flat-square)](https://github.com/desktop/desktop/blob/master/LICENSE)
[![license](https://img.shields.io/github/license/desktop/desktop.svg?style=flat-square)](https://github.com/desktop/desktop/blob/development/LICENSE)
![90+% TypeScript](https://img.shields.io/github/languages/top/desktop/desktop.svg?style=flat-square&colorB=green)

GitHub Desktop is an open source [Electron](https://electron.atom.io)-based
Expand Down Expand Up @@ -42,22 +42,22 @@ beta channel to get access to early builds of Desktop:

- [macOS](https://central.github.com/deployments/desktop/desktop/latest/darwin?env=beta)
- [Windows](https://central.github.com/deployments/desktop/desktop/latest/win32?env=beta)

## Is GitHub Desktop right for me? What are the primary areas of focus?

[This document](https://github.com/desktop/desktop/blob/master/docs/process/what-is-desktop.md) describes the focus of GitHub Desktop and who the product is most useful for.
[This document](https://github.com/desktop/desktop/blob/development/docs/process/what-is-desktop.md) describes the focus of GitHub Desktop and who the product is most useful for.

And to see what the team is working on currently and in the near future, check out the [GitHub Desktop roadmap](https://github.com/desktop/desktop/blob/master/docs/process/roadmap.md).
And to see what the team is working on currently and in the near future, check out the [GitHub Desktop roadmap](https://github.com/desktop/desktop/blob/development/docs/process/roadmap.md).

## I have a problem with GitHub Desktop

Note: The [GitHub Desktop Code of Conduct](https://github.com/desktop/desktop/blob/master/CODE_OF_CONDUCT.md) applies in all interactions relating to the GitHub Desktop project.
Note: The [GitHub Desktop Code of Conduct](https://github.com/desktop/desktop/blob/development/CODE_OF_CONDUCT.md) applies in all interactions relating to the GitHub Desktop project.

First, please search the [open issues](https://github.com/desktop/desktop/issues?q=is%3Aopen)
and [closed issues](https://github.com/desktop/desktop/issues?q=is%3Aclosed)
to see if your issue hasn't already been reported (it may also be fixed).

There is also a list of [known issues](https://github.com/desktop/desktop/blob/master/docs/known-issues.md)
There is also a list of [known issues](https://github.com/desktop/desktop/blob/development/docs/known-issues.md)
that are being tracked against Desktop, and some of these issues have workarounds.

If you can't find an issue that matches what you're seeing, open a [new issue](https://github.com/desktop/desktop/issues/new/choose),
Expand Down
12 changes: 6 additions & 6 deletions docs/contributing/linux-testing-and-you.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Feel free to submit other questions or suggestions to [`shiftkey/desktop`](https

## Contributing Fixes

If you are interested in testing installers locally, first ensure your [development environment is setup](https://github.com/desktop/desktop/blob/master/docs/contributing/setup.md) to build and test Desktop.
If you are interested in testing installers locally, first ensure your [development environment is setup](https://github.com/desktop/desktop/blob/development/docs/contributing/setup.md) to build and test Desktop.

Once your environment is setup, you can create an installer locally by running:

Expand All @@ -50,16 +50,16 @@ We use `electron-packager` to generate the artifacts and `electron-builder` to g

`electron-packager` details:

* [API options](https://github.com/electron-userland/electron-packager/blob/master/docs/api.md#options)
* [`dist-info.js` config file](https://github.com/desktop/desktop/blob/master/script/dist-info.js)
* [Usage in Desktop](https://github.com/desktop/desktop/blob/master/script/build.ts#L98-L151)
* [API options](https://github.com/electron-userland/electron-packager/blob/development/docs/api.md#options)
* [`dist-info.js` config file](https://github.com/desktop/desktop/blob/development/script/dist-info.js)
* [Usage in Desktop](https://github.com/desktop/desktop/blob/development/script/build.ts#L98-L151)

`dist-info.js` contains the various metadata we provide to Desktop as part of packaging. This seems fairly stable, but we might need to tweak some things in here for Linux-specific changes.

`electron-builder` details:

* [API options](https://www.electron.build/configuration/linux)
* [`electron-builder-linux.yml` config file](https://github.com/desktop/desktop/blob/master/script/electron-builder-linux.yml)
* [Usage in Desktop](https://github.com/desktop/desktop/blob/master/script/package.ts#L124-L145)
* [`electron-builder-linux.yml` config file](https://github.com/desktop/desktop/blob/development/script/electron-builder-linux.yml)
* [Usage in Desktop](https://github.com/desktop/desktop/blob/development/script/package.ts#L124-L145)

We use `electron-builder-linux.yml` to configure the installers, so please investigate the documentation if you find a problem with an installer to see if something has been overlooked and can be fixed fairly easily.
4 changes: 2 additions & 2 deletions docs/contributing/styleguide.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,9 @@ and leave a blank line before you go into detail, similar to a git commit messag

## Visibility of AppStore Methods

The [`Dispatcher`](https://github.com/desktop/desktop/blob/master/app/src/lib/dispatcher/dispatcher.ts)
The [`Dispatcher`](https://github.com/desktop/desktop/blob/development/app/src/lib/dispatcher/dispatcher.ts)
is the entry point for most interactions with the application which update state,
and for most usages this work is then delegated to the [`AppStore`](https://github.com/desktop/desktop/blob/master/app/src/lib/stores/app-store.ts).
and for most usages this work is then delegated to the [`AppStore`](https://github.com/desktop/desktop/blob/development/app/src/lib/stores/app-store.ts).
Due to this coupling, we need to discourage callers directly manipulating
specific methods in the `AppStore` unless there's a compelling reason.

Expand Down
4 changes: 2 additions & 2 deletions docs/process/notes-for-contributors.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ 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
- keep up to date with `development` - 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
When merging, we prefer you merge `development` into your branch, but for small
PRs a rebase is fine.

### These Things Take Time
Expand Down
2 changes: 1 addition & 1 deletion docs/process/pull-request-triage.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Examples of exceptional situations:
version

- [#4319](https://github.com/desktop/desktop/pull/4319) was a minor packaging
change introduced unexpectedly on `master` but would affect everyone when they
change introduced unexpectedly on `development` but would affect everyone when they
updated their local repositories.

These should be called out by the merging person with a `#jolo` - "Josh Only
Expand Down
2 changes: 1 addition & 1 deletion docs/process/quality-process.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
### Desktop Quality
This document is a general outline of Quality Engineering practices for Desktop, both for scheduled and ad-hoc testing. The manual test cases used to test Desktop in both Mac and Windows can be found [here](https://github.com/desktop/desktop/blob/master/docs/process/testing.md).
This document is a general outline of Quality Engineering practices for Desktop, both for scheduled and ad-hoc testing. The manual test cases used to test Desktop in both Mac and Windows can be found [here](https://github.com/desktop/desktop/blob/development/docs/process/testing.md).

#### Test Cases
The test cases are relevant to the latest build of Desktop, and the manifest is broken down into sections that include installation, setup, adding repositories, general use, and OS-specific cases, among others. As the manifest is a living document, it may sometimes include future features as Quality needs to stay slightly ahead of the roadmap.
Expand Down
2 changes: 1 addition & 1 deletion docs/process/release-planning.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Pull Requests associated with features for our marketing releases should have a
milestone defined as soon as possible, to indicate the anticipated release and
help track.

Pull requests for new features should leverage [feature flags](https://github.com/desktop/desktop/blob/master/docs/technical/feature-flagging.md),
Pull requests for new features should leverage [feature flags](https://github.com/desktop/desktop/blob/development/docs/technical/feature-flagging.md),
so we can control when a feature is made available to users. If you are using
the GitHub Desktop [beta channel](https://github.com/desktop/desktop#beta-channel)
you will be able to help test and provide feedback about upcoming features
Expand Down
22 changes: 11 additions & 11 deletions docs/process/releasing-updates.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ We have three channels to which we can release: `production`, `beta`, and `test`

- `production` is the channel from which the general public downloads and receives updates. It should be stable and polished.

- `beta` is released more often than `production`. We want to ensure `master` is always in a state where it can be released to users, so it should be used as the source for `beta` releases as an opportunity for additional QA before releasing to `production`.
- `beta` is released more often than `production`. We want to ensure `development` is always in a state where it can be released to users, so it should be used as the source for `beta` releases as an opportunity for additional QA before releasing to `production`.

- `test` is unlike the other two. It does not receive updates. Each test release is locked in time. It's used entirely for providing test releases.

## The Process

### 1. GitHub Access Token

From a clean working directory, set the `GITHUB_ACCESS_TOKEN` environment variable to a valid [Personal Access Token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/)
From a clean working directory, set the `GITHUB_ACCESS_TOKEN` environment variable to a valid [Personal Access Token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/)

To check that this environment variable is set in your shell:

Expand All @@ -37,7 +37,7 @@ If you are creating a new Personal Access Token on GitHub:
* make the token memorable - use a description like `Desktop Draft Release and Changelog Generator`
* the `read:org` scope is the **only** required scope for drafting releases

To set this access token as an environment in your shell:
To set this access token as an environment in your shell:

**Bash (macOS, Linux or Git Bash)**
```shellsession
Expand Down Expand Up @@ -92,14 +92,14 @@ Here's what you should do next:
3. Update the release notes to have user-friendly summary lines
4. For issues prefixed with [???], look at the PR and update the prefix to one of: [New], [Added], [Fixed], [Improved], [Removed]
5. Sort the entries so that the prefixes are ordered: [New], [Added], [Fixed], [Improved], [Removed]
6. Commit the changes (on master or as new branch) and push them to GitHub
7. Read this to perform the release: https://github.com/desktop/desktop/blob/master/docs/process/releasing-updates.md
6. Commit the changes (on development or as new branch) and push them to GitHub
7. Read this to perform the release: https://github.com/desktop/desktop/blob/development/docs/process/releasing-updates.md
```

_Note: You should ensure the `version` in `app/package.json` is set to the new version and follows the [semver format](https://semver.org/) of `major.minor.patch`._
_Note: You should ensure the `version` in `app/package.json` is set to the new version and follows the [semver format](https://semver.org/) of `major.minor.patch`._

Examples:
* for prod, `1.1.0` -> `1.1.1` or `1.1.13` -> `1.2.0`
* for prod, `1.1.0` -> `1.1.1` or `1.1.13` -> `1.2.0`
* for beta, `1.1.0-beta1` -> `1.1.0-beta2` or `1.1.13-beta3` -> `1.2.0-beta1`
* for test, `1.0.14-test2` -> `1.0.14-test3` or `1.1.14-test3` -> `1.2.0-test1`

Expand All @@ -120,15 +120,15 @@ Here's an example of the previous changelog draft after it has been edited:

Create a new branch to represent the work that will be released to users:

- for `beta` releases, branch from `master` to ensure the latest changes are published
- for `beta` releases, branch from `development` to ensure the latest changes are published
- for `production` releases, branch from the latest beta tag
- to find this tag: `git tag | grep 'beta' | sort -r | head -n 1`

If you are creating a new beta release, the `yarn draft-release beta` command will help you find the new release entries for the changelog.

If you are create a new `production` release, you should just combine and sort the previous `beta` changelog entries.

Add your new changelog entries to `changelog.json`, update the version in `app/package.json`, commit the changes, and push this branch to GitHub. This becomes the release branch, and lets other maintainers continue to merge into `master` without affecting your release.
Add your new changelog entries to `changelog.json`, update the version in `app/package.json`, commit the changes, and push this branch to GitHub. This becomes the release branch, and lets other maintainers continue to merge into `development` without affecting your release.

If a maintainer would like to backport a pull request to the next release, it is their responsibilty to co-ordinate with the release owner and ensure they are fine with accepting this work.

Expand Down Expand Up @@ -161,9 +161,9 @@ You will also see this in Chat:

When the release in Central is in `State: released` for `beta` or `production`, switch to your installed Desktop instance and make sure that the corresponding (prod|beta) app auto-updates.

Testing that an update is detected, downloaded, and applied correctly is very important - if this is somehow broken during development then our users will not likely stay up to date!
Testing that an update is detected, downloaded, and applied correctly is very important - if this is somehow broken during development then our users will not likely stay up to date!

If you don't have the app for `beta`, for example, you can always download the previous version on Central to see it update
If you don't have the app for `beta`, for example, you can always download the previous version on Central to see it update

_Make sure you move your application out of the Downloads folder and into the Applications folder for macOS or it won't auto-update_.

Expand Down
2 changes: 1 addition & 1 deletion docs/technical/adding-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ tests to exercise your work.

### Adding tests to a test module

Feel free to borrow ideas from our [current test suite](https://github.com/desktop/desktop/tree/master/app/test/unit),
Feel free to borrow ideas from our [current test suite](https://github.com/desktop/desktop/tree/development/app/test/unit),
but here are some guidelines to help you figure out what to test.

- focus on a specific module or function when writing unit tests - complex unit
Expand Down
Loading

0 comments on commit d4be778

Please sign in to comment.