zxing/.github/CONTRIBUTING.md

52 lines
2 KiB
Markdown
Raw Permalink Normal View History

2014-09-02 03:58:06 -07:00
## Contributing
The project is in maintenance mode, meaning, changes are driven by contributed patches.
2018-12-07 05:04:40 -08:00
Only bug fixes. The Barcode Scanner app can
no longer be published, so almost no fixes will be accepted for it.
There is otherwise no development or roadmap for this project.
2014-09-02 03:58:06 -07:00
Only proposed changes in the form of a pull request are likely to be acted on, but,
these will be acted on promptly.
### Feature Requests
2018-12-07 05:04:40 -08:00
Feature requests are not accepted.
2014-09-02 03:58:06 -07:00
### Bug Reports
Bug reports must have enough detail to understand and reproduce the problem.
Bug reports without an associated pull request will generally be closed.
2018-12-07 05:04:40 -08:00
However, bug reports with a pull request are likely to be merged promptly.
2014-09-02 03:58:06 -07:00
2019-11-04 06:36:21 -08:00
## FAQ
Please search previous issues for an answer before opening a pull request. A few common ones
are listed here.
2024-02-16 07:58:26 -08:00
### This doesn't work on later Androids
The Barcode Scanner app cannot be updated or published further, and will not be updated.
It does not work on Android 14+ and will not.
### I get a compilation error
2019-11-04 06:36:21 -08:00
While you can check the build status on Github to confirm,
the project correctly builds and passes tests at all times.
90% of the time it's due to using an old version of Java. Version 3.4+ require Java 8.
2019-11-04 06:36:21 -08:00
Use earlier versions with Java 7 and earlier.
### This barcode doesn't decode
2019-11-04 06:36:21 -08:00
Not all images will decode. All else equal, more is better, but this is not accepted as a bug
report. A pull request that makes changes to make the barcode decode without decreasing the net
number of barcodes recognized in the unit tests may be considered.
2019-10-06 20:50:13 -07:00
## Licensing
2014-09-02 03:58:06 -07:00
Contributions via GitHub pull requests are gladly accepted from their original author.
Along with any pull requests, please state that the contribution is your original work and
that you license the work to the project under the project's open source license.
Whether or not you state this explicitly, by submitting any copyrighted material via
pull request, email, or other means you agree to license the material under the project's
open source license and warrant that you have the legal authority to do so.