Thanks for contributing to the examples repository.
Every example lives in a {language}/{example-name}/ directory:
- source files for the example
- a
README.mddocumenting how to run it and what it teaches
Current categories:
python/javascript/html-css/
If an example needs a new language, create the new category folder at the same level and keep the example inside it.
Every example README should include:
- A
#title matching the example name ## Description- one short paragraph explaining what the example does## Run- the command or open instructions needed to try it## Learning Goals- a bullet list of beginner-friendly takeaways- Optional
## Previewor screenshots when the result is visual
Use existing READMEs such as python/hello-world/README.md as the reference shape.
- Fork the repository and create a branch from
main. - Add the example under the correct category folder.
- Keep the code simple, commented where useful, and runnable locally.
- Add a README following the format above.
- Test the example before opening the pull request.
- Push the branch and open a pull request using the repository template.
- Describe what the example teaches and how you verified it.
- Keep examples simple and focused on one concept.
- Write beginner-friendly code with clear names.
- Include a README for every example.
- Avoid dependencies when a standard library version is just as clear.
- Add screenshots only when they help someone understand a visual example.