Skip to content

Latest commit

 

History

History
63 lines (45 loc) · 3.64 KB

CONTRIBUTING.md

File metadata and controls

63 lines (45 loc) · 3.64 KB
Raw

How To Contribute

If you have an interest in contributing to this project, here is some advice for packaging your contribution. Thanks!

Contributing Bug Reports

Most likely the most common contribution to a library like this will be bug reports. These come in two varieties: stuff that probably pertains to camera hardware, and other sorts of bugs.

All bug reports need to include:

  • the Build.MANUFACTURER and Build.PRODUCT values for the hardware on which you are experiencing the problem
  • the code necessary to reproduce the problem (this could be one of the demo apps, or it could be some demo project of yours that you publish)
  • the steps necessary, using that code and that hardware, to reproduce the problem

Bug Reports about Camera Picture Output

If pictures taken using this library are coming out incorrectly (garbled, incorrect colors, too-small sizes, etc.), the best way to document that bug is by running the demo/ app from the project and attaching the ZIP archive it generates to your issue. The demo/ app not only takes four pictures (two per orientation, two per camera) and includes them in the ZIP archive, but the ZIP also contains a JSON file with some hardware details to help identify your hardware, including the Build.MANUFACTURER and Build.PRODUCT values.

If you cannot reproduce the bug using the demo app, but you can reproduce using your own app, include the CameraActivity.IntentBuilder configuration code that you are using, along with any other code snippets that you think might pertain to the problem, when you post your issue.

Bug Reports about Camera Preview Output

Unfortunately, the demo/ app is not presently capturing previews and including them in the ZIP. If you can reproduce the preview bug using the demo/ app, try to take a screenshot or otherwise capture an image of what you are seeing in the preview that is a problem, and include it in your issue.

If you cannot reproduce the problem with the demo/ app, but you can reproduce using your own app, include the CameraActivity.IntentBuilder configuration code that you are using, along with any other code snippets that you think might pertain to the problem, and your screenshot illustrating the preview problem, when you post your issue.

Contributing Feature Requests

If you have an idea for how to make the library better, feel free to file an issue. You will have better luck in getting the feature implemented if you can "sell" the library author on how this feature will help the library author.

Asking for Other Sorts of Help

Please read the project documentation for instructions on where and how to ask questions. Note that questions regarding using unsupported APIs in your project (e.g., working directly with CameraFragment) will not get much in the way of a response, as there are reasons why those APIs are "unsupported". :-)

Contributing Code

This project is not set up to accept much in the way of pull requests or other code contributions, for licensing and contractual reasons, not technical ones.

If you send over a pull request, and it is a de minimis fix (i.e., there is no other reasonable way to affect the change other than how you did it), your pull request may be accepted and merged in directly. Otherwise, pull requests or other code samples will be used as inspiration for a fresh implementation, rather than used directly.