From 537693f5cf613123188380552541ce1163f12ac0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jozef=20Holl=C3=BD?= Date: Mon, 28 Aug 2017 09:42:44 +0200 Subject: [PATCH] README, CONTRIBUTING and ISSUE_TEMPLATE, Discord (#952) * Include discord, change issue segment * Update CONTRIBUTING.md * Update ISSUE_TEMPLATE.md --- .github/CONTRIBUTING.md | 29 ++++++++++++++--------------- .github/ISSUE_TEMPLATE.md | 6 ------ README.md | 11 ++++++----- 3 files changed, 20 insertions(+), 26 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 0c2dda36b..b77cf7f29 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,6 +1,17 @@ +1. **Before reporting a new issue, take a look at the [FAQ](https://github.com/inorichi/tachiyomi/wiki/FAQ), the [changelog](https://github.com/inorichi/tachiyomi/releases) and the already opened [issues](https://github.com/inorichi/tachiyomi/issues).** +2. If you are unsure, ask here: [![Discord](https://img.shields.io/discord/349436576037732353.svg)](https://discord.gg/WrBkRk4) +3. What is your type of issue? + * [Catalogue request](#catalogue-requests) + * [Bugs](#bugs) + * [Feature requests](#feature-requests) + * [Translations](https://github.com/inorichi/tachiyomi/wiki/Translation) +4. After following 1. and 3. you can [open your issue](https://github.com/inorichi/tachiyomi/issues/new) + +*** + # Catalogue requests -* Catalogue requests should be created at https://github.com/inorichi/tachiyomi-extensions/issues, not here +* Catalogue requests should be created at https://github.com/inorichi/tachiyomi-extensions#readme, not here # Bugs * Include version (Setting > About > Version) @@ -8,17 +19,9 @@ * Dev version is equal to the number of commits as seen in the main page * Include steps to reproduce (if not obvious from description) * Include screenshot (if needed) -* If it could be device-dependent, try reproducing on another device (if possible), include results and device names, OS, modifications (root, Xposed) -* **Before reporting a new issue, take a look at the [FAQ](https://github.com/inorichi/tachiyomi/wiki/FAQ), the [changelog](https://github.com/inorichi/tachiyomi/releases) and the already opened [issues](https://github.com/inorichi/tachiyomi/issues).** +* If it could be device-dependent, try reproducing on another device (if possible) * For large logs use http://pastebin.com/ (or similar) -* For multipart issues **use list** like this: - * [x] Done - * [ ] Not done -``` -* [x] Done -* [ ] Not done -``` -* Don't put together too many unrelated requests into one issue +* Don't group unrelated requests into one issue DO: https://github.com/inorichi/tachiyomi/issues/24 https://github.com/inorichi/tachiyomi/issues/71 @@ -28,7 +31,3 @@ DON'T: https://github.com/inorichi/tachiyomi/issues/75 * Write a detailed issue, explaning what it should do or how. Avoid writing just "like X app does" * Include screenshot (if needed) - -# Translations - -[Wiki](https://github.com/inorichi/tachiyomi/wiki/Translation) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 47f813ac5..c2b4ab5a7 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,7 +1 @@ **Please read https://github.com/inorichi/tachiyomi/blob/master/.github/CONTRIBUTING.md before posting** - -Remove line above and describe your issue here. Fill out version below. Use Preview. - - -Version: r000 or v0.0.0 -(other relevant info like OS) diff --git a/README.md b/README.md index 6c4ed5e34..3ef10af61 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,11 @@ -| Build | Download | F-Droid | -|-------|----------|-------------| -| [![TeamCity (simple build status)](https://img.shields.io/teamcity/https/teamcity.kanade.eu/s/tachiyomi_Build.svg)](https://teamcity.kanade.eu/project.html?projectId=tachiyomi) [![Travis](https://img.shields.io/travis/inorichi/tachiyomi.svg)](https://travis-ci.org/inorichi/tachiyomi) | [![stable release](https://img.shields.io/github/release/inorichi/tachiyomi.svg?maxAge=3600&label=stable)](https://github.com/inorichi/tachiyomi/releases) [![latest dev build](https://img.shields.io/badge/dev-latest%20build-blue.svg)](http://tachiyomi.kanade.eu/latest/app-debug.apk) | [![fdroid release](https://img.shields.io/badge/stable-f--droid.org-blue.svg)](https://f-droid.org/repository/browse/?fdid=eu.kanade.tachiyomi) [![fdroid dev](https://img.shields.io/badge/dev-wiki-blue.svg)](//github.com/inorichi/tachiyomi/wiki/FDroid-for-dev-versions) | +| Build | Download | F-Droid | Contact | +|-------|----------|---------|---------| +| [![TeamCity (simple build status)](https://img.shields.io/teamcity/https/teamcity.kanade.eu/s/tachiyomi_Build.svg)](https://teamcity.kanade.eu/project.html?projectId=tachiyomi) [![Travis](https://img.shields.io/travis/inorichi/tachiyomi.svg)](https://travis-ci.org/inorichi/tachiyomi) | [![stable release](https://img.shields.io/github/release/inorichi/tachiyomi.svg?maxAge=3600&label=stable)](https://github.com/inorichi/tachiyomi/releases) [![latest dev build](https://img.shields.io/badge/dev-latest%20build-blue.svg)](http://tachiyomi.kanade.eu/latest/app-debug.apk) | [![fdroid release](https://img.shields.io/badge/stable-f--droid.org-blue.svg)](https://f-droid.org/repository/browse/?fdid=eu.kanade.tachiyomi) [![fdroid dev](https://img.shields.io/badge/dev-wiki-blue.svg)](//github.com/inorichi/tachiyomi/wiki/FDroid-for-dev-versions) | [![Discord](https://img.shields.io/discord/349436576037732353.svg)](https://discord.gg/WrBkRk4) | -## [Report an issue](https://github.com/inorichi/tachiyomi/blob/master/.github/CONTRIBUTING.md) +### **Contact us on [Discord](https://discord.gg/WrBkRk4)** +If you want to open an issue, please read [contributing guidelines](https://github.com/inorichi/tachiyomi/blob/master/.github/CONTRIBUTING.md). Your issue may be closed otherwise. -**Before reporting a new issue, take a look at the [FAQ](https://github.com/inorichi/tachiyomi/wiki/FAQ), the [changelog](https://github.com/inorichi/tachiyomi/releases) and the already opened issues.** +*** Tachiyomi is a free and open source manga reader for Android.