Louvorg/ReaderforSelfoss
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Amine Bou 2017-10-02 12:50:35 +02:00 committed by GitHub
parent 737fe9bb4a
commit 94d23888b1
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
.github/CONTRIBUTING.md vendored
View File

@ -52,20 +52,21 @@ You'll have to:
- mercuryApiKey: A [Mercury](https://mercury.postlight.com/web-parser/) web parser api key for the internal browser - mercuryApiKey: A [Mercury](https://mercury.postlight.com/web-parser/) web parser api key for the internal browser
- feedbackEmail: An email to receive users feedback. - feedbackEmail: An email to receive users feedback.
- sourceUrl: an url to the source code, used in the settings - sourceUrl: an url to the source code, used in the settings. **It can be empty.**
- trackerUrl: an url to the tracker, used in the settings - trackerUrl: an url to the tracker, used in the settings. **It can be empty.**
- appLoginUrl, appLoginUsername and appLoginPassword: url, username and password of a selfoss instance. **These are only used for tests. They can be empty if you don't test API calls.**
### Examples: ### Examples:
#### Inside ~/.gradle/gradle.properties #### Inside ~/.gradle/gradle.properties
``` ```
appLoginUrl="URL" appLoginUrl="URL" # It can be empty.
appLoginUsername="LOGIN" appLoginUsername="LOGIN" # It can be empty.
appLoginPassword="PASS" appLoginPassword="PASS" # It can be empty.
mercuryApiKey="LONGAPIKEY" mercuryApiKey="LONGAPIKEY"
feedbackEmail="EMAIL" feedbackEmail="EMAIL"
sourceUrl="URLSOURCE" sourceUrl="URLSOURCE" # It can be empty.
trackerUrl="URLTRACKER" trackerUrl="URLTRACKER" # It can be empty.
``` ```
#### As gradle parameters #### As gradle parameters