book-reader/CONTRIBUTING.md
Aryan b47b6a9164
Added stylus-only mode for PDF drawing and annotations. (#27)
This change introduces a "Stylus Only Mode" toggle in the annotation dock, allowing users to restrict drawing input to stylus pens while maintaining touch support for scrolling and navigation.

Key changes include:
- Added `isStylusOnlyMode` state and persistence logic in `PdfViewerScreen`.
- Updated `AnnotationDock` with a toggle button for the new mode.
- Modified pointer input handling in `PdfPageComposable` and `PdfVerticalReader` to filter touch events when stylus-only mode is active.
- Adjusted tap gesture detection to ensure scrolling and page clicks still function correctly under various input modes.
2026-03-04 13:18:26 +05:30

33 lines
No EOL
1.7 KiB
Markdown

# Contributing to Episteme
Thank you for considering contributing to Episteme!
## The Open-Core Model & Why We Use a CLA
Episteme is built by an independent developer (Aryan Raj) using an **Open-Core** model. This means:
1. The core application (this repository) is 100% open-source under the **AGPL** license.
2. To sustain the project's development, there is also a proprietary, commercial **Episteme** version available on the Google Play Store.
Because the AGPL is a strict "copyleft" license, any code you contribute here is implicitly AGPL. If I were to put your AGPL code into the Play Store version, the Play Store version would legally be forced to become fully open-source as well.
To solve this, we require a **Contributor License Agreement (CLA)**.
By signing the CLA, you are saying: *"I still own my code, but I give Aryan Raj permission to use it in both the open-source repo and the proprietary Play Store app."*
You can read the full CLA [here](CLA.md).
This allows the open-source version to thrive while keeping the project sustainable.
## How to Submit a Pull Request
1. Fork the repository.
2. Make your changes and commit them with clear, descriptive messages.
3. Open a Pull Request!
4. **Sign the CLA:** When you open your first PR, the [CLA Assistant](https://cla-assistant.io/) bot will automatically comment with a link. Simply click the link, sign in with GitHub, and click "I agree." **This is a one-time process**, once signed, it covers all your future contributions to Episteme.
## Questions?
If you have any questions about the CLA, contributing, or anything else, feel free to open an issue or reach out.
Thank you for helping make Episteme better for everyone!