Apktool/.github/CONTRIBUTING.md

22 lines
1.0 KiB
Markdown
Raw Normal View History

2014-02-10 02:14:29 +01:00
# Contributing
A couple of quick tips to ease the submission process.
2015-10-24 09:36:00 +02:00
* You may use [Github](https://github.com/iBotPeaches/Apktool) or [Bitbucket](https://bitbucket.org/iBotPeaches/apktool/) to submit a pull request.
2014-02-10 02:14:29 +01:00
2015-10-24 09:36:00 +02:00
* Please reference the bug number from our [issue list](https://github.com/iBotPeaches/Apktool/issues) in any pull requests to help associate fixes with bugs.
2014-02-10 02:14:29 +01:00
* If possible, add unit-tests for any bugs that you fix.
2015-10-24 09:36:00 +02:00
* [Building](http://ibotpeaches.github.io/Apktool/build/) via Gradle will automatically run unit-tests. The build will end if any test fails.
2014-02-10 02:14:29 +01:00
* [IntelliJ IDEA](http://www.jetbrains.com/idea/) is our IDE of choice. It has built in debugger support along with Gradle integration.
2014-02-10 02:14:29 +01:00
* For changes to smali/baksmali please see their [page](https://github.com/google/smali) for more information.
## Code Styles
* A rough guideline based on [AOSP Guidelines](https://source.android.com/source/code-style.html).
* A tab counts as 4 spaces and we use 4 spaces.
* Our right margin is 120 characters long.