1.9 KiB
Contributing
Thanks for your interest in contributing to FairScan.
Before contributing, please take a moment to understand the scope of the project. FairScan is an app that focuses on simplicity. The goal is to provide a fast, reliable scanning experience without requiring manual adjustments.
- The goal is not to re-implement all features found in similar apps
- The goal is not to give users control over every aspect of the generated PDFs
Recommended reading: https://fairscan.org/blog/fairscan-purpose/
Issues
You're very welcome to describe the problems you face when using FairScan.
When the automatic processing gives a bad result, please share the original image whenever possible. You can get it by tapping "Report a problem with last captured image" in the "About" screen. You can either attach the image to the GitHub issue or send it privately to contact@fairscan.org. Screenshots are usually not helpful to understand image-processing issues.
The most useful issues focus on the problem rather than on a proposed solution. Understanding the underlying problem is essential to finding the right solution. A detailed description of the problem and its context is therefore usually much more valuable than discussing a specific change to the app.
Pull Requests
- Please avoid starting any significant work without discussing it first.
- Small, focused PRs are much easier to review and integrate.
- FairScan is primarily developed by its maintainer, and core parts of the app are implemented directly to ensure consistency with the overall vision. Large or architectural changes are unlikely to be accepted.
Project direction
FairScan is currently maintained by a single person, and product and technical decisions are centralized. This helps keep the project consistent and aligned with its original vision, and may evolve in the future.
Thanks for your understanding.