2019-07-31 16:46:59 +00:00
|
|
|
# Contributing
|
2018-02-02 08:58:41 +00:00
|
|
|
|
2023-07-05 22:18:47 +00:00
|
|
|
Please note, we have [code of conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
|
2019-07-31 16:46:59 +00:00
|
|
|
|
|
|
|
|
## Open Issue
|
|
|
|
|
|
2023-07-05 22:18:47 +00:00
|
|
|
1. Before proceed, please do:
|
2019-07-31 16:46:59 +00:00
|
|
|
- check [Troubleshooting Q&A](https://github.com/skylot/jadx/wiki/Troubleshooting-Q&A) section on wiki
|
|
|
|
|
- search existing issues by exception message
|
|
|
|
|
|
2023-07-05 22:18:47 +00:00
|
|
|
2. Describe error:
|
2020-04-24 12:23:58 +00:00
|
|
|
- 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)
|
2019-07-31 16:46:59 +00:00
|
|
|
|
2023-07-05 22:18:47 +00:00
|
|
|
**Note**: GitHub don't allow attaching files with `.apk` extension, but you can change extension by adding `.zip` at the end :)
|
2019-07-31 16:46:59 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
## Pull Request Process
|
|
|
|
|
|
2023-07-05 22:18:47 +00:00
|
|
|
1. Please don't submit any code style fixes or dependencies updates changes.
|
2019-07-31 16:46:59 +00:00
|
|
|
|
2023-07-05 22:18:47 +00:00
|
|
|
1. Use only features and API from Java 11 or below.
|
2019-07-31 16:46:59 +00:00
|
|
|
|
|
|
|
|
1. Make sure your code is correctly formatted, see description here: [Code Formatting](https://github.com/skylot/jadx/wiki/Code-Formatting).
|
|
|
|
|
|
2023-07-05 22:18:47 +00:00
|
|
|
1. Make sure your changes are passing build: `./gradlew clean build dist`
|
