From 204219c367c4b88f98a37b72b31452dab16efb07 Mon Sep 17 00:00:00 2001 From: Samuel Carlsson Date: Thu, 28 Jul 2016 19:22:01 +0200 Subject: [PATCH] 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