Minor documentation cleanup - bug templates, readme, etc. (#2507)
This commit is contained in:
Joshua Lund
Scott Nonnenberg
parent
6a611cbecf
commit
80d5484325
4 changed files with 23 additions and 26 deletions
4
.github/ISSUE_TEMPLATE.md
vendored
4
.github/ISSUE_TEMPLATE.md
vendored
|
|
@ -7,7 +7,7 @@ locations if you have a question or comment:
|
|||
|
||||
https://community.signalusers.org/
|
||||
http://support.signal.org/
|
||||
support@whispersystems.org
|
||||
support@signal.org
|
||||
|
||||
Lastly, be sure to preview your issue before saving. Thanks!
|
||||
-->
|
||||
|
|
@ -15,7 +15,7 @@ Lastly, be sure to preview your issue before saving. Thanks!
|
|||
* [ ] I have searched open and closed issues for duplicates
|
||||
<!--
|
||||
You can search all issues here:
|
||||
https://github.com/WhisperSystems/Signal-Desktop/issues?utf8=%E2%9C%93&q=is%3Aissue
|
||||
https://github.com/signalapp/Signal-Desktop/issues?utf8=%E2%9C%93&q=is%3Aissue
|
||||
Replace [ ] with [X] once you've searched
|
||||
-->
|
||||
|
||||
|
|
|
|||
10
.github/PULL_REQUEST_TEMPLATE.md
vendored
10
.github/PULL_REQUEST_TEMPLATE.md
vendored
|
|
@ -9,15 +9,15 @@ Remember, you can preview this before saving it.
|
|||
|
||||
### First time contributor checklist:
|
||||
|
||||
* [ ] I have read the [README](https://github.com/WhisperSystems/Signal-Desktop/blob/master/README.md) and [Contributor Guidelines](https://github.com/WhisperSystems/Signal-Desktop/blob/master/CONTRIBUTING.md)
|
||||
* [ ] I have signed the [Contributor Licence Agreement](https://whispersystems.org/cla/)
|
||||
* [ ] I have read the [README](https://github.com/signalapp/Signal-Desktop/blob/master/README.md) and [Contributor Guidelines](https://github.com/signalapp/Signal-Desktop/blob/master/CONTRIBUTING.md)
|
||||
* [ ] I have signed the [Contributor Licence Agreement](https://signal.org/cla/)
|
||||
|
||||
### Contributor checklist:
|
||||
|
||||
* [ ] My contribution is **not** related to translations. _Please submit translation changes via our [Signal Desktop Transifex project](https://www.transifex.com/liliakai/signal-desktop/)._
|
||||
* [ ] My commits are in nice logical chunks with [good commit messages](http://chris.beams.io/posts/git-commit/)
|
||||
* [ ] My changes are [rebased](https://medium.freecodecamp.org/git-rebase-and-the-golden-rule-explained-70715eccc372) on the latest [`development`](https://github.com/WhisperSystems/Signal-Desktop/tree/development) branch
|
||||
* [ ] My changes pass 100% of [local tests](https://github.com/WhisperSystems/Signal-Desktop/blob/master/CONTRIBUTING.md#tests)
|
||||
* [ ] My changes are [rebased](https://medium.freecodecamp.org/git-rebase-and-the-golden-rule-explained-70715eccc372) on the latest [`development`](https://github.com/signalapp/Signal-Desktop/tree/development) branch
|
||||
* [ ] My changes pass 100% of [local tests](https://github.com/signalapp/Signal-Desktop/blob/master/CONTRIBUTING.md#tests)
|
||||
* [ ] My changes are ready to be shipped to users
|
||||
|
||||
### Description
|
||||
|
|
@ -26,7 +26,7 @@ Remember, you can preview this before saving it.
|
|||
Describe briefly what your pull request changes. Focus on the value provided to users.
|
||||
|
||||
Does it address any outstanding issues in this project?
|
||||
https://github.com/WhisperSystems/Signal-Desktop/issues?utf8=%E2%9C%93&q=is%3Aissue
|
||||
https://github.com/signalapp/Signal-Desktop/issues?utf8=%E2%9C%93&q=is%3Aissue
|
||||
Reference an issue with the hash symbol: "#222"
|
||||
If you're fixing it, use something like "Fixes #222"
|
||||
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ your intentions and get feedback from the users most likely to appreciate your c
|
|||
You're most likely to have your pull request accepted easily if it addresses bugs already
|
||||
in the [Next Steps project](https://github.com/signalapp/Signal-Desktop/projects/1),
|
||||
especially if they are near the top of the Backlog column. Those are what we'll be looking
|
||||
at next, so it would be a great help if you helped us out!
|
||||
at next, so it would be great if you helped us out!
|
||||
|
||||
Once you've spent a little bit of time planning your solution, it's a good idea to go
|
||||
back to the issue and talk about your approach. We'd be happy to provide feedback. [An
|
||||
|
|
@ -96,7 +96,7 @@ Desktop to populate your testing application!
|
|||
|
||||
First, find your application data:
|
||||
|
||||
* OSX: `~/Library/Application Support/Signal`
|
||||
* macOS: `~/Library/Application Support/Signal`
|
||||
* Linux: `~/.config/Signal`
|
||||
* Windows 10: `C:\Users\<YourName>\AppData\Roaming\Signal`
|
||||
|
||||
|
|
@ -214,11 +214,11 @@ of the Signal experience requires a primary mobile device: contact management,
|
|||
synchronizing read and verification states among all linked devices, etc.
|
||||
|
||||
This presents a problem - even if you had another phone, the production versions of the
|
||||
iOS and Android apps are locked to the production servers. To test all secenarios in
|
||||
iOS and Android apps are locked to the production servers. To test all scenarios in
|
||||
staging, your best bet is to pull down the development version of the iOS or Android app,
|
||||
and register it with one of your extra phone numbers:
|
||||
|
||||
First, build Signal for Android or iOS from source, and point its TextSecure service URL to `textsecure-service-staging.whispersystems.org`:
|
||||
First, build Signal for Android or iOS from source, and point its service URL to `textsecure-service-staging.whispersystems.org`:
|
||||
|
||||
**on Android:** Replace the `SIGNAL_URL` value in [build.gradle](https://github.com/signalapp/Signal-Android/blob/master/build.gradle)
|
||||
|
||||
|
|
|
|||
27
README.md
27
README.md
|
|
@ -2,30 +2,28 @@
|
|||
Signal Desktop
|
||||
==========================
|
||||
|
||||
Signal Desktop is an Electron application that links with your
|
||||
[Signal Android](https://github.com/signalapp/Signal-Android)
|
||||
or [Signal iOS](https://github.com/signalapp/Signal-iOS) app.
|
||||
Signal Desktop is an Electron application that links with Signal
|
||||
on [Android](https://github.com/signalapp/Signal-Android)
|
||||
or [iOS](https://github.com/signalapp/Signal-iOS).
|
||||
|
||||
## Install production version: https://signal.org/download/
|
||||
## Install the production version: https://signal.org/download/
|
||||
|
||||
## Install the beta
|
||||
|
||||
You can install it on a computer which already has the production version installed. It uses different data and install locations.
|
||||
You can install the beta version of Signal Desktop alongside the production version. The beta uses different data and install locations.
|
||||
|
||||
* _Windows:_ First, download this yml file: https://updates.signal.org/desktop/beta.yml In it, you'll find a `url` property which will specify the installer location. Download the installer by constructing the final url: `https://updates.signal.org/desktop/<installer location>`. Then run the installer.
|
||||
* _Mac:_ First, download this yml file: https://updates.signal.org/desktop/beta-mac.yml. In it, you find a `url` property which will specify the package location. Download that package by constructing the final url: `https://updates.signal.org/desktop/<package locatdion>`. Then unzip that package and copy the `.app` file into `/Applications` in Finder.
|
||||
* _Linux:_ same instructions as the production install steps linked above, but run `apt-get install signal-desktop-beta` instead
|
||||
* _Windows:_ First, download [this file](https://updates.signal.org/desktop/beta.yml) and look for the `url` property that specifies the location for the latest beta installer. Download the installer by constructing a final URL that looks like this: `https://updates.signal.org/desktop/<installer location>`. Then run the installer.
|
||||
* _macOS:_ First, download [this file](https://updates.signal.org/desktop/beta-mac.yml) and look for the `url` property that specifies the location for the latest beta installer. Download the installer by constructing a final URL that looks like this: `https://updates.signal.org/desktop/<package location>`. Then unzip that package and copy the `.app` file into the `/Applications` folder using Finder.
|
||||
* _Linux:_ Follow the production instructions to set up the APT repository and run `apt install signal-desktop-beta`.
|
||||
|
||||
## Got a question?
|
||||
|
||||
You can find answers to a number of frequently asked questions on our support site: https://support.signal.org/.
|
||||
The community forum is another good place for questions: https://community.signalusers.org/.
|
||||
You can find answers to a number of frequently asked questions on our [support site](https://support.signal.org/).
|
||||
The [community forum](https://community.signalusers.org/) is another good place for questions.
|
||||
|
||||
## Found a Bug? Have a feature request?
|
||||
|
||||
Please search the existing issues for your bug and create a new one if the issue is not yet tracked!
|
||||
|
||||
https://github.com/signalapp/Signal-Desktop/issues
|
||||
Please search for any [existing issues](https://github.com/signalapp/Signal-Desktop/issues) that describe your bug in order to avoid duplicate submissions.
|
||||
|
||||
## Contributing Translations
|
||||
|
||||
|
|
@ -36,8 +34,7 @@ https://www.transifex.com/projects/p/signal-desktop
|
|||
## Contributing Code
|
||||
|
||||
Please see [CONTRIBUTING.md](https://github.com/signalapp/Signal-Desktop/blob/master/CONTRIBUTING.md)
|
||||
for setup instructions and contributor guidelines. And don't forget to sign the
|
||||
[CLA](https://signal.org/cla/).
|
||||
for setup instructions and guidelines for new contributors. Don't forget to sign the [CLA](https://signal.org/cla/).
|
||||
|
||||
## Contributing Funds
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue