Community
LibreShard is built in the open, by volunteers. Bug reports, shards, translations, documentation and code are all welcome.
Talk to us
Section titled “Talk to us”- Discussions: questions, ideas and showing off your shards.
- Issues: bug reports and concrete proposals.
- Email: [email protected]. For security problems, follow the security page instead.
Ways to help
Section titled “Ways to help”Report a bug
Section titled “Report a bug”Open an issue with your LibreShard version, your system (and desktop on Linux), what you did and what happened. Check the FAQ first: the answer may be there.
Share a shard
Section titled “Share a shard”You don’t need to change LibreShard for that. Create your shard, publish it in your own repository, and tell people about it in the discussions.
Propose a bundled shard
Section titled “Propose a bundled shard”Open an issue first. Bundled shards must work with the declarative data-key / data-hold
attributes, ship English and Spanish texts, and use no third-party material (logos, images, fonts).
Translate
Section titled “Translate”The app’s texts live in i18n/en.json and i18n/es.json in the
LibreShard repository; a new language is a new file with
the same keys. This website’s pages are in the
website repository, under src/content/docs/, and every
page has an “Edit page” link at the bottom.
Write code
Section titled “Write code”Read the contributing guide for the setup, the conventions and how pull requests work. CONTEXT.md explains the architecture, the protocol and the security model. The roadmap lists what’s coming, and help is welcome on any of it.
The rules
Section titled “The rules”Code of conduct
Section titled “Code of conduct”Everyone taking part follows the code of conduct (the Contributor Covenant 3.0). In short: be kind and assume good faith; harassment and personal attacks aren’t tolerated. To report a problem, write to [email protected]: only the maintainers read it.
Signing off your commits
Section titled “Signing off your commits”Contributions are licensed under the project’s license: Apache-2.0 for the app, MIT-0 for the shard
template and the shared shard files. Every commit carries a Signed-off-by line, the
Developer Certificate of Origin, stating that you wrote the
change or have the right to submit it:
git commit -sBoth repositories ask for it, and the app’s CI checks it on every pull request.
The name and logo
Section titled “The name and logo”You can say that something works with LibreShard, and redistribute unmodified releases. Forks need their own name and icon. The details are in the trademark policy.