From 204219c367c4b88f98a37b72b31452dab16efb07 Mon Sep 17 00:00:00 2001 From: Samuel Carlsson Date: Thu, 28 Jul 2016 19:22:01 +0200 Subject: [PATCH 1/4] Adding short contributing text and link from README.md This will help newcomers get into the code quickly, and will also make it easier to merge pull requests. --- CONTRIBUTING.md | 28 ++++++++++++++++++++++++++++ README.md | 5 +++++ 2 files changed, 33 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..8bc1118 --- /dev/null +++ b/CONTRIBUTING.md @@ -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. :-) \ No newline at end of file diff --git a/README.md b/README.md index e469d98..0a9f79b 100644 --- a/README.md +++ b/README.md @@ -62,5 +62,10 @@ project name and **tag** ignoring actual values from pom.xml. So you need to wri ``` +## Contributing ## +This project would not be where it is if it where not for the many helpful contributors +supporting jadb with pull requests, issue reports, and great ideas. If _you_ would like to +contribute, please read through [CONTRIBUTING.md](CONTRIBUTING.md). + ## Author ## Samuel Carlsson \ No newline at end of file From 4cdff4b399b5ca573418ab08d79d8f0261f4cfa0 Mon Sep 17 00:00:00 2001 From: Samuel Carlsson Date: Thu, 28 Jul 2016 22:24:11 +0200 Subject: [PATCH 2/4] Adding link to contributors and license file. --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0a9f79b..03f8ffb 100644 --- a/README.md +++ b/README.md @@ -67,5 +67,10 @@ This project would not be where it is if it where not for the many helpful contr supporting jadb with pull requests, issue reports, and great ideas. If _you_ would like to contribute, please read through [CONTRIBUTING.md](CONTRIBUTING.md). -## Author ## -Samuel Carlsson \ No newline at end of file +## Authors ## +Samuel Carlsson + +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. From dac19a0696ca902829706f7e1c85b1eb7e37dcba Mon Sep 17 00:00:00 2001 From: Samuel Carlsson Date: Thu, 28 Jul 2016 22:29:51 +0200 Subject: [PATCH 3/4] Cleaning up README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 03f8ffb..98d8f47 100644 --- a/README.md +++ b/README.md @@ -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 devices = jadb.getDevices(); + List 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 ``` @@ -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: ``` @@ -63,7 +63,7 @@ project name and **tag** ignoring actual values from pom.xml. So you need to wri ``` ## Contributing ## -This project would not be where it is if it where not for the many helpful contributors +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). From 1c3de5c9634ceba7769c79b4608256ff38a8dc3c Mon Sep 17 00:00:00 2001 From: Samuel Carlsson Date: Thu, 28 Jul 2016 22:42:58 +0200 Subject: [PATCH 4/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 98d8f47..f8805fb 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,7 @@ project name and tag ignoring actual values from pom.xml. So you need to write: ``` ## Contributing ## -This project would not be where it is if it where not for the helpful [contributors](https://github.com/vidstige/jadb/graphs/contributors) +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).