Contribute
Corrections and suggestions are welcome.
Report an error
Open an issue in the repository on GitHub. Say which page it is on, quote the sentence, number, or figure that is wrong, and say what you expected. If a listing does not run on your machine, add your operating system, the output of uv --version, and the command that failed with its output.
To correct a scientific statement, use the Scientific correction form: it asks for the page, the statement, the correction, a source with its licence, and the evidence. A scientific change needs a source, a licence that allows its use, and independent review before it is merged. To suggest a real dataset a lesson could learn from, use the Dataset suggestion form: source, creator, licence, measurement type, size, and what a lesson could learn from it. No form asks for contact details, and you do not need to contact JIDAI or anyone else; the outcome is recorded on the issue.
Educators who teach with a lesson report what an instructor pack lacked in the same way.
Do not put secrets in an issue. A security-sensitive finding follows the security policy.
Propose a change
Start with an issue that describes the problem or the proposal. Changes land through pull requests, and a pull request cannot be merged while ./scripts/verify.sh fails. The contributing guide has the steps, and the authoring guide explains how to write a lesson.
To propose a new lesson, open an issue from the Lesson proposal form. The assessment criteria, and the path from an accepted proposal to a merged lesson, are in the content proposals guide. A draft may be written by you or, from an accepted proposal, by an agent on the maintainer’s machine; either way it lands through a reviewed pull request that passes the same verification as every lesson.
Licence of contributions
By submitting a contribution you agree that it is licensed under the licences of the repository:
- code, including lesson code, tests, and Lean proofs, under the MIT licence;
- lesson text and figures under the Creative Commons Attribution 4.0 International licence.
Only contribute material you have the right to license this way. When you include third-party material, name its source and licence in the pull request.