Contributing to the project
Lore is open source. Feedback, issues, code, documentation and translations are welcome.
Documentation for version 0.1, in preparation. Commands, variables and API endpoints are proposals: they may change before the release.
On this page
Before you start
- Read the code of conduct and the contributing guide.
- For a significant change, open an issue first to discuss it.
- Issues and discussions can be written in English or in French; code and commit messages are in English.
Contributor License Agreement
Before your first contribution, you will sign a Contributor License Agreement (CLA), based on the Apache Software Foundation’s; its text will be published before the first outside contribution. You will keep the copyright on your code; the agreement will let the project also distribute it under other licenses, which funds its development.
Propose a change
- Create a branch
From
main, in your copy of the repository. - Add tests Any change to access rights must be covered by tests that check who can see what.
- Open a pull request Describe the problem solved and how to check the change.
Improve the documentation
Every page can be edited on GitHub, with the Edit this page on GitHub link at the bottom of the page. The documentation lives with the website, in the dada-core/lore-site repository: Markdown files in src/content/docs/, en/ for English, fr/ for French, one file per page and per language. Pull requests target the develop branch.
Edit both languages if you can. If you only write one, say so in the pull request: the translation will be done before publication.
Report a vulnerability
Privately only, never in a public issue. See Security and sign-in.