From 83196628c9a445206924a013523f675a5e72bd72 Mon Sep 17 00:00:00 2001 From: Skylot Date: Fri, 24 Apr 2020 13:23:58 +0100 Subject: [PATCH] docs: fix issue and PR templates --- .github/ISSUE_TEMPLATE/decompilation-error.md | 8 +++----- .github/pull_request_template.md | 4 ++-- CONTRIBUTING.md | 11 +++++------ README.md | 2 -- 4 files changed, 10 insertions(+), 15 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/decompilation-error.md b/.github/ISSUE_TEMPLATE/decompilation-error.md index ef763a65c..27516b57c 100644 --- a/.github/ISSUE_TEMPLATE/decompilation-error.md +++ b/.github/ISSUE_TEMPLATE/decompilation-error.md @@ -13,10 +13,8 @@ assignees: '' - search existing issues by exception message **Describe error** -- provide full name of method or class with error -- provide full java stacktrace - - **Note**: no need to copy method fallback code (commented pseudocode) -- attach or provide link to apk file (double check apk version) +- full name of method or class with error +- full java stacktrace (no need to copy method fallback code (commented pseudocode)) +- **IMPORTANT!** attach or provide link to apk file (double check apk version) **Note**: GitHub don't allow attach files with `.apk` extension, but you can change extension by adding `.zip` at the end :) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 65dc0edf9..12ce91efb 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,5 +1,5 @@ -:exclamation: Please review the [guidelines for contributing](../CONTRIBUTING.md#Pull-Request-Process) +:exclamation: Please review the [guidelines for contributing](https://github.com/skylot/jadx/blob/master/CONTRIBUTING.md#Pull-Request-Process) ### Description Please describe your pull request. -Reference issue it fix. +Reference issue it fixes. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 561caed2a..a08fbd08a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,11 +10,10 @@ Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in - search existing issues by exception message 2. Describe error - - provide full name of method or class with error - - provide full java stacktrace - - **Note**: no need to copy method fallback code (commented pseudocode) - - attach or provide link to apk file (double check apk version) + **Describe error** + - full name of method or class with error + - full java stacktrace (no need to copy method fallback code (commented pseudocode)) + - **IMPORTANT!:** attach or provide link to apk file (double check apk version) **Note**: GitHub don't allow attach files with `.apk` extension, but you can change extension by adding `.zip` at the end :) @@ -23,7 +22,7 @@ Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in 1. Please don't submit any code style fixes, dependencies updates or other changes which are not fixing any issues. -1. Before open a PR please discuss the change you wish to make via issue. PR without corresponding issue will be rejected. +1. Before start working on PR please discuss the change you wish to make via issue. PR without corresponding issue will be rejected. 1. Use only features and API from Java 8 or below. diff --git a/README.md b/README.md index de7e6cdff..963a1fced 100644 --- a/README.md +++ b/README.md @@ -121,5 +121,3 @@ To support this project you can: --------------------------------------- *Licensed under the Apache 2.0 License* - -*Copyright 2019 by Skylot*