Skip to content

Latest commit

 

History

History
29 lines (18 loc) · 1.64 KB

File metadata and controls

29 lines (18 loc) · 1.64 KB

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

  • Bug reports are very welcome, especially with reproducible examples or images. When the automatic processing gives bad results, you can share the captured image by tapping "Report a problem with last captured image" in the "About" screen.
  • Before opening a "feature request", please consider whether the issue can be described more generally. Focus on describing problems rather than solutions, and provide as much context as possible. Try to explain why something should be changed, and the use case you face.

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.