Shake to send a bug report!

Development Status

Maintained

• Not currently under active development.
• Active development may resume in the future.
• Bug reports will be triaged and fixed. No guarantees are made regarding fix timelines.
• Feature requests will be triaged. No guarantees are made regarding acceptance or implementation timelines.
• Pull requests from external contributors are not currently being accepted.

Introduction

BugShaker allows your QA team and/or end 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.

This library is similar to Telescope, but aims to be even easier to integrate into your apps and workflows:

• all configuration occurs in your custom Application subclass (no view hierarchy alterations required);
• no need to request extra permissions;
• iOS version of this library is already available (based on the same shake-to-send mechanism).

Screenshots

Prompt	Email

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 {
       implementation("com.github.stkent:bugshaker:{latest-version}")
   }
   

2. Configure the shared BugShaker instance in your custom Application class, then call assemble and 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
                    .setAlertDialogType(AlertDialogType.NATIVE) // optional
                    .setLoggingEnabled(BuildConfig.DEBUG)       // optional
                    .setIgnoreFlagSecure(true)                  // optional
                    .assemble()                                 // required
                    .start();                                   // required
       }
   }

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

Advanced Usage

If you would like to customize the alert dialog presented to users when a shake is detected, update your BugShaker configuration as follows:

• Remove any setAlertDialogType calls;
• Add a call to setCustomDialogProvider, passing in your own DialogProvider instance.

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.