Contributing
This site is written as plain Markdown files in a public repository, and anyone can propose a change. This page explains how to contribute and what the CC0 public domain dedication means for your contribution.
If you are unsure about anything, ask, or submit the issue or pull request anyway. You will be asked politely to change anything that needs it.
Ways to help
- Report a mistake, an unclear step, or a broken link. Use the issue tracker.
- Improve an existing page.
- Add a prompt or a script.
- Check a page against its sources and tell us what you found.
How to contribute
- Read Authoring conventions. Each convention says whether the checker tests it or it is guidance.
- Try Your first prompt if you have never used the tools. The tools need Python 3.10 or newer.
- Fork the repository, and make your change on a branch of your fork.
- Run the tools described in Tooling. If you changed a prompt, a script, or an image, run the sync tool first. Then run the checker, and fix every error.
- Open a pull request. Say what changed, and give a source for every fact or number you added.
- Before a page’s status moves to “stable”, follow the Release checklist.
Do not include personal data, keys, or file paths from your own computer in any contribution.
What CC0 means for your contribution
CC0 1.0 Universal is a public domain dedication. The person who dedicates a work gives up their copyright and related rights, to the extent the law allows. Anyone may then copy, change, and reuse the work for any purpose without asking permission.
This page is a plain-language guide, not legal advice. These points matter most to contributors.
- Your contribution is released under CC0. By opening a pull request or filing an issue, you agree that your contribution is dedicated to the public domain. Only submit what you are willing to give away.
- Do not submit third-party content that you cannot dedicate to the public domain. This covers text, images, code, and data taken from books, courses, articles, websites, or other repositories. Content under a license that asks for credit, limits commercial use, or requires sharing alike cannot be dedicated by you. State a fact in your own words and cite the source.
- AI-generated text is welcome only if you have checked it and it is not copied from a source you cannot reuse. Check every fact, number, command, and link. AI tools can produce text that closely matches existing sources, so you remain responsible for what you submit.
- CC0 does not grant patent or trademark rights. It covers copyright and related rights only. Product and project names appear on this site only to describe those products and projects. Their owners keep their rights, and a mention does not mean endorsement or affiliation.
For the exact terms, read the CC0 1.0 Universal legal code and the repository’s CONTRIBUTING.md.
Pages in this section
- Authoring conventions: how to write pages, prompts, and scripts.
- Tooling: the checker, the sync tool, and local preview.
- Release checklist: automated and manual checks before a page is called stable.
- Your first prompt: a 15-minute walkthrough.
- Extending this guide: adapting this guide’s own method to a new subject-matter domain, running example, or agentic platform.