CONTRIBUTING.md 1.4 KB
Newer Older
1
# Contributing
R
Ryan Goggins 已提交
2

3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.

## Open Issue

1. Before proceed please do:
    - check [latest unstable build](https://bintray.com/skylot/jadx/unstable/_latestVersion#files) (maybe issue already fixed)
    - check [Troubleshooting Q&A](https://github.com/skylot/jadx/wiki/Troubleshooting-Q&A) section on wiki
    - 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)

      **Note**: GitHub don't allow attach files with `.apk` extension, but you can change extension by adding `.zip` at the end :)


## Pull Request Process

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. Use only features and API from Java 8 or below.

1. If possible don't add additional dependencies especially if they are big.

1. Make sure your code is correctly formatted, see description here: [Code Formatting](https://github.com/skylot/jadx/wiki/Code-Formatting).

1. Make sure your changes is passing build: `./gradlew clean build dist`