ReVanced-Mirror/jadb
1
0
Fork 0
mirror of https://github.com/revanced/jadb.git synced 2024-06-10 15:17:52 +02:00
Code Issues Projects Releases Wiki Activity

Merge pull request #28 from vidstige/contributing

Browse Source 
Adding short contributing text and link from README.md
This commit is contained in:
Samuel Carlsson 2016-07-28 22:48:53 +02:00 committed by GitHub
commit f362563e82
2 changed files with 44 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,28 @@
# Contributing #
## Why contributing? ##
The original author and all users of this library are very greatful for your contribution
to this Open Source Project. Also most employers value people active in the Open Source
community.
## The Checklist ##
If you want to help out and contribute to this Open Source Project, please keep reading.
My thought with `jadb` was to make it very light weight and easy to use as a developer.
This means as little boilerplate code, (mostly) self-documenting public interface, and
overall clean code.
Before submitting a pull request, please go through the below checklist to verify
your proposed change meets, or exceeds, the quality of the jadb source code.
* Builds - Make sure the code builds by issuing `ant build`.
* Works - Make sure all the test runs and passes.
* Works - Double check any features you might have changed, and of course any _new_ code
by testing manually.
* Formatting - Keep the formatting _consistent_. Nothing
fancy, pretty standard java stuff, check other source files
for reference.
* Readability - Is your code easy to read? This usually means shorter code, but don't go
full terse.
* Newline at end of file - This makes `cat`-ing files, etc easier.
Happy coding! I, the original author, and all users are greatful for your contribution. :-)

22
README.md
View File

@ -13,7 +13,7 @@ This projects aims at providing an up to date implementation of the ADB protocol
Usage cannot be simpler. Just create a `JadbConnection` and off you go.
JadbConnection jadb = new JadbConnection();
List<JadbDevice> devices = jadb.getDevices();
List<JadbDevice> devices = jadb.getDevices();
Make sure the adb server is running. You can start it by running `adb` once from the command line.
@ -39,8 +39,8 @@ A list of the available commands that a ADB Server may accept can be found here:
Since version v1.1 Jadb support [maven](https://maven.apache.org/) as a build system. Although this project is not presented in official apache maven
repositories this library can be used as dependencies in your maven/gradle project with the help of [jitpack](https://jitpack.io).
[Оitpack](https://jitpack.io) is a system which parse github public repositories and make artifacts from them.
You will just only need to add [jitpack](https://jitpack.io) as a repository to let maven/gradle to search for artifacts in it
[Jitpack](https://jitpack.io) is a system which parses github public repositories and make artifacts from them.
You only need to add [jitpack](https://jitpack.io) as a repository to let maven/gradle to search for artifacts in it, like so
```
<repositories>
@ -52,7 +52,7 @@ You will just only need to add [jitpack](https://jitpack.io) as a repository to
```
After that you will need to add actual dependency. [Jitpack](https://jitpack.io) takes groupId, artifactId and version id from repository name,
project name and **tag** ignoring actual values from pom.xml. So you need to write:
project name and tag ignoring actual values from pom.xml. So you need to write:
```
<dependency>
@ -62,5 +62,15 @@ project name and **tag** ignoring actual values from pom.xml. So you need to wri
</dependency>
```
## Author ##
Samuel Carlsson <samuel.carlsson@gmai.com>
## Contributing ##
This project would not be where it is, if it where not for the helpful [contributors](https://github.com/vidstige/jadb/graphs/contributors)
supporting jadb with pull requests, issue reports, and great ideas. If _you_ would like to
contribute, please read through [CONTRIBUTING.md](CONTRIBUTING.md).
## Authors ##
Samuel Carlsson <samuel.carlsson@gmai.com>
See [contributors](https://github.com/vidstige/jadb/graphs/contributors) for a full list.
## License ##
This project is released under the Apache License Version 2.0, see [LICENSE.md](LICENSE.md) for more information.