diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 2d08379f9a..5bbbc08856 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,33 +1,25 @@ -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/tachiyomi) -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) +> [!IMPORTANT] +> Looking to report an issue/bug or make a feature request? Please refer to the [README file](https://github.com/null2264/yokai#contributing). -*** +--- -# Catalogue requests +Thanks for your interest in contributing to Yōkai! -* Catalogue requests should be created at https://github.com/inorichi/tachiyomi-extensions#readme, not here +# Code contributions -# Bugs -* Include version (Setting > About > Version) - * If not latest, try updating, it may have already been solved - * 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) -* For large logs use http://pastebin.com/ (or similar) -* Don't group unrelated requests into one issue +Pull requests are welcome! -DO: https://github.com/inorichi/tachiyomi/issues/24 https://github.com/inorichi/tachiyomi/issues/71 +If you're interested in taking on [an open issue](https://github.com/null2264/yokai/issues), please comment on it so others are aware. +You do not need to ask for permission nor an assignment. -DON'T: https://github.com/inorichi/tachiyomi/issues/75 +## Prerequisites -# Feature requests +Before you start, please note that the ability to use following technologies is **required** and that existing contributors will not actively teach them to you. -* Write a detailed issue, explaning what it should do or how. Avoid writing just "like X app does" -* Include screenshot (if needed) +- Basic [Android development](https://developer.android.com/) +- [Kotlin](https://kotlinlang.org/) + +### Tools + +- [Android Studio](https://developer.android.com/studio) +- Emulator or phone with developer options enabled to test changes. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index c077d158bd..ab7b559561 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,8 +1,5 @@ blank_issues_enabled: false contact_links: - - name: 📘 Main Tachiyomi issue - url: https://github.com/tachiyomiorg/tachiyomi/issues/new/choose - about: Issues that exist on both this fork AND the original Tachiyomi should be opened in the tachiyomi repository instead - - name: 🖥️ Tachiyomi website - url: https://tachiyomi.org/help/ - about: Guides, troubleshooting, and answers to common questions \ No newline at end of file + - name: 🖥️ Mihon website + url: https://mihon.app/help/ + about: Guides, troubleshooting, and answers to common questions diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 6060622478..3af97cf618 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -33,7 +33,7 @@ body: required: true - label: If this is an request for a feature in the original Tachiyomi, I am opening because multiple versions of Yōkai have been released without this feature. required: true - - label: If this is an issue with an extension, or a request for an extension, I should be opening an issue in the [extensions repository](https://github.com/tachiyomiorg/tachiyomi-extensions/issues/new/choose). + - label: If this is an issue with an extension, or a request for an extension, I should be contacting the extensions repository's maintainer/support for help. required: true - label: I have updated the app to version **[1.7.11](https://github.com/null2264/yokai/releases/latest)**. required: true diff --git a/.github/ISSUE_TEMPLATE/issue_report.yml b/.github/ISSUE_TEMPLATE/issue_report.yml index b55736e3df..3c3dbe730b 100644 --- a/.github/ISSUE_TEMPLATE/issue_report.yml +++ b/.github/ISSUE_TEMPLATE/issue_report.yml @@ -94,11 +94,11 @@ body: required: true - label: I have written a short but informative title. required: true - - label: If this is an issue with an extension, I should be opening an issue in the [extensions repository](https://github.com/tachiyomiorg/tachiyomi-extensions/issues/new/choose). + - label: If this is an issue with an extension, or a request for an extension, I should be contacting the extensions repository's maintainer/support for help. required: true - - label: I am reporting an issue exclusive to this fork. I have also checked that is not an issue on the [main version of Tachiyomi](https://github.com/tachiyomiorg/tachiyomi) + - label: I am reporting an issue exclusive to this fork. I have also checked that is not an issue on the [main version of Mihon](https://github.com/mihonapp/mihon) required: true - - label: I have tried the [troubleshooting guide](https://tachiyomi.org/help/guides/troubleshooting/). + - label: I have tried the [troubleshooting guide](https://mihon.app/help/). required: true - label: I have updated the app to version **[1.7.11](https://github.com/null2264/yokai/releases/latest)**. required: true @@ -106,4 +106,4 @@ body: required: true - label: I have admitted that I am a clown by having checked this box, as I have not read these acknowledgements. - label: I have filled out all of the requested information in this form. - required: true \ No newline at end of file + required: true diff --git a/README.md b/README.md index a7edb4d579..095b735278 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,7 @@ Pull requests are welcome. For major changes, please open an issue first to disc
Issues -**Before reporting a new issue, take a look at the [FAQ](https://github.com/tachiyomiorg/tachiyomi/wiki/FAQ), the [changelog](https://github.com/null2264/yokai/releases) and the already opened [issues](https://github.com/null2264/yokai/issues).** +**Before reporting a new issue, take a look at the [FAQ](https://mihon.app/docs/faq/general), the [changelog](https://github.com/null2264/yokai/releases) and the already opened [issues](https://github.com/null2264/yokai/issues).**
@@ -90,8 +90,8 @@ Pull requests are welcome. For major changes, please open an issue first to disc * If it could be device-dependent, try reproducing on another device (if possible). * For large logs use [Pastebin](https://pastebin.com/) (or similar). * Don't group unrelated requests into one issue. -- **DO**: [Example #1](https://github.com/tachiyomiorg/tachiyomi/issues/24), [Example #2](https://github.com/tachiyomiorg/tachiyomi/issues/71). -- **DON'T**: [Example #1](https://github.com/tachiyomiorg/tachiyomi/issues/75). +- **DO**: [Example #1](https://web.archive.org/web/20240117150729/https://github.com/tachiyomiorg/tachiyomi/issues/24), [Example #2](https://web.archive.org/web/20240117150735/https://github.com/tachiyomiorg/tachiyomi/issues/71). +- **DON'T**: [Example #1](https://web.archive.org/web/20240117150741/https://github.com/tachiyomiorg/tachiyomi/issues/75). @@ -134,4 +134,4 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. - \ No newline at end of file +