Skip to content
Shake to send a bug report!
Java Prolog Shell
Branch: master
Clone or download
Latest commit 36427ea Oct 14, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Add PR template Dec 31, 2016
assets Remove image shadows Mar 8, 2017
bugshaker Clean up Oct 13, 2019
example Use Java 8 Oct 13, 2019
gradle/wrapper Update gradle Oct 13, 2019
.gitignore Update .gitignore Jun 24, 2016
.travis.yml Manually install v29 build tools; clean up .travis.yml Oct 13, 2019
CHANGELOG.md Update CHANGELOG for v1.4.1 Dec 18, 2017
CONTRIBUTING.md Update contributing guidelines Dec 31, 2016
HEADER_LICENSE.txt Replace javadoc header licenses with comments Mar 7, 2017
LICENSE Add LICENSE file Oct 16, 2016
README.md
build.gradle Remove resolutionStrategy Oct 13, 2019
gradle.properties Clean up gradle.properties Oct 13, 2019
gradlew Update project Dec 13, 2017
gradlew.bat Update Gradle wrapper and plugin Mar 3, 2017
settings.gradle Rename library module Jan 8, 2016
travis-build.sh Update project for Gnag 1.3.1 Mar 6, 2017

README.md

The BugShaker logo

Shake to send a bug report!

Build Status Download Android Arsenal

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

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, 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.

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.
You can’t perform that action at this time.