Send Android bug reports via email. Shake to summon!

Introduction

BugShaker-Android allows your testers and/or users to easily submit bug reports by shaking their device. When a shake is detected, the current screen state is captured and the user is prompted to submit a bug report via email with this screenshot attached.

The iOS version of BugShaker was written by Dan Trenz and is available here. This Android version builds on Square's shake-detection library, seismic.

Screenshots

Play Store Demo App

https://play.google.com/store/apps/details?id=com.github.stkent.bugshaker

Getting Started

(1) Specify BugShaker-Android as a dependency in your build.gradle file:

dependencies {
    compile 'com.github.stkent:bugshaker:{latest-version}'
}

(2) Configure the shared BugShaker instance in your custom Application class, and call start() to begin listening for shakes:

public class CustomApplication extends Application {

    @Override
    public void onCreate() {
        super.onCreate();

        BugShaker.get(this)
                 .setEmailAddresses("someone@example.com")   // required
                 .setEmailSubjectLine("Custom Subject Line") // optional
                 .setLoggingEnabled(BuildConfig.DEBUG)       // optional
                 .setIgnoreFlagSecure(true)                  // optional
                 .start();                                   // required
    }

}

It is recommended that logging always be disabled in production builds.

Contributing

Issue Tracking

Library issues are tracked using GitHub Issues. Please review all tag types to understand issue categorization.

Always review open issues before opening a new one. If you would like to work on an existing issue, please comment to that effect and assign yourself to the issue.

Conventions

Code committed to this project must pass selected style and correctness checks provided by:

• FindBugs™;
• PMD;
• checkstyle.

This helps us focus on content only when reviewing contributions.

You can run these checks locally by executing the following Gradle command:

./gradlew checkLocal

Travis CI runs the same checks for each pull request and marks the build as failing if any check does not pass. Detailed information about every detected violation will be automatically posted to the conversation for that pull request. Violation detection and reporting is handled by the gnag Gradle plugin.

Generating Inline Licenses

Before opening a pull request, you must generate license headers in any new source files by executing the Gradle command:

./gradlew licenseFormat

The Travis CI pull request build will fail if any source file is missing this generated header.

License

Copyright 2016 Stuart Kent

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.