Skip to content

Commit e70f4e4

Browse files
authored
Contributing guidelines (#166)
1 parent 8fae0ba commit e70f4e4

2 files changed

Lines changed: 44 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## Contributing
2+
3+
Thanks for your interest in contributing to FairScan.
4+
5+
Before contributing, please take a moment to understand the scope of the project.
6+
FairScan is an app that focuses on simplicity. The goal is to provide a fast, reliable scanning experience without requiring manual adjustments.
7+
8+
- The goal is not to re-implement all features found in similar apps
9+
- The goal is not to give users control over every aspect of the generated PDFs
10+
11+
Recommended reading: https://fairscan.org/blog/fairscan-purpose/
12+
13+
### Issues
14+
15+
- 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.
16+
- 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.
17+
18+
### Pull Requests
19+
20+
- Please avoid starting any significant work without discussing it first.
21+
- Small, focused PRs are much easier to review and integrate.
22+
- 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.
23+
24+
### Project direction
25+
26+
FairScan is currently maintained by a single person, and product and technical decisions are centralized.
27+
This helps keep the project consistent and aligned with its original vision, and may evolve in the future.
28+
29+
Thanks for your understanding.

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,12 @@ And **respectful**: open source, minimal permissions, no tracking, no ads.
3232

3333
---
3434

35+
## Contributing
36+
37+
Contributions are welcome, but please read the guidelines first: [CONTRIBUTING.md](CONTRIBUTING.md)
38+
39+
---
40+
3541
## Screenshots
3642

3743
| Scan | Preview | Save & Share |
@@ -54,6 +60,15 @@ And **respectful**: open source, minimal permissions, no tracking, no ads.
5460

5561
---
5662

63+
## What FairScan is not
64+
65+
FairScan is **not** intended to:
66+
- provide fine-grained manual control over document processing
67+
- replicate all features found in other scanning apps
68+
- optimize for highly specific use cases at the expense of simplicity
69+
70+
---
71+
5772
## Compatibility
5873

5974
FairScan works on any device that:

0 commit comments

Comments
 (0)