Thanks for your interest in contributing! SeforimLibrary is part of Zayit and follows the same rules, which keep the project clean and legally clear.
SeforimLibrary, like Zayit, is licensed under the Zayit Public License: the GNU AGPL v3,
plus a grant back to the maintainer, the "Powered by the technologies that drive
Zayit — https://zayitapp.com/" attribution and a trademark clause. See
LICENSE for the full text.
By submitting a contribution (pull request, patch, or any other form), you license it under the same terms as the project. There is no CLA to sign.
Zayit is open core (see "Open core" in Zayit's README): its core, SeforimLibrary included, is free under the Zayit Public License, and its official builds also include proprietary modules, such as the smart siddur. Section 3 of the license lets your contribution be part of those builds too:
- You keep the copyright on your contribution — there is no copyright assignment.
- By submitting it (or by distributing a modified version, in a fork for instance), you grant the maintainer a broad license on it, which allows distributing it under other terms too (including with proprietary modules), and a patent license.
Every commit must be signed off under the Developer Certificate of Origin 1.1. By signing off, you certify that you wrote the code or otherwise have the right to submit it under the project's license.
Add a sign-off line to each commit:
Signed-off-by: Your Name <your.email@example.com>
The easy way is to use the -s flag:
git commit -s -m "Your message"To sign off the last commit you forgot to sign:
git commit --amend -s --no-editA CI check enforces that every commit in a pull request is signed off.
Full text of the Developer Certificate of Origin 1.1
Developer Certificate of Origin
Version 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or
(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or
(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.
(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
- Comments in code must be written in English.
- Kotlin code must follow Kotlin conventions and idiomatic style.
- Run the tests before opening a PR:
./gradlew test