Contributing

Contributions are welcome when they make the course clearer, more accurate, or easier to reuse.

Follow the code of conduct in all project spaces.

Report An Error

Open an issue when a course page, a screenshot, or a link is wrong or out of date. Give the page, the step, and the date when you saw the problem. The GitHub interface changes often, so the date helps.

Propose A Change

  1. Open an issue first for a large change, a new exercise, or new tooling.
  2. Create a branch from main.
  3. Keep one logical change in one pull request.
  4. Use a Conventional Commit subject, for example docs: clarify sub-issue step in X2.
  5. Run the checks that AGENTS.md names before you request a review.
  6. Wait for a maintainer review before you merge.

Rules For Course Content

  • Use only synthetic data in public examples. Never add real personal data or real research data.
  • Give each claimed rule a source, its applicability, and its status.
  • Keep an unconfirmed fact visibly marked as unconfirmed.
  • Capture a new screenshot from the current GitHub interface. Give it a date and alt text, and check it for private information.
  • Keep maintainer tooling out of the learner prerequisites. Learners need a browser and a GitHub account. The command-line route also needs git and gh.
Back to top