Skip to content

Latest commit

 

History

History
79 lines (52 loc) · 2.4 KB

File metadata and controls

79 lines (52 loc) · 2.4 KB

Contributing

Thanks for your interest in contributing.

You do not need to be an expert to help. If you used this project and found something unclear, broken, or hard to follow, your feedback is useful.

What Contributions Are Welcome

You can open an issue or pull request for:

  • unclear README instructions
  • broken links, images, videos, or demos
  • loading problems in Codex, Claude Code, or other coding agents
  • confusing workflow steps
  • safer prompts or clearer wording
  • public-safe examples and use cases
  • translation or documentation fixes
  • small bug reports with enough context to reproduce the problem

What Not To Include

Please do not include:

  • private local paths
  • private chat logs
  • client, student, or user materials
  • copyrighted assets without permission
  • copied surface designs from other people's work
  • fake stars, fake usage claims, or promotional spam
  • internal prompt chains or private workflow details
  • large unrelated feature requests

This project welcomes reusable methods, not surface-level copying.

Issues

When opening an issue, please include:

  • what you tried to do
  • what happened
  • what you expected
  • your environment, if relevant
  • public-safe screenshots or links, if helpful

A good issue does not need to be long. It only needs to help the maintainer understand the problem.

Pull Requests

Small documentation fixes are welcome.

For workflow changes, please open an issue first and explain the use case. This helps keep the public version focused, lightweight, and safe.

If your pull request changes core workflow behavior, please explain:

  • what problem it solves
  • whether it affects existing users
  • whether it introduces privacy, copyright, or compatibility risks

Public-Safe Examples

Examples are welcome, but they must be public-safe.

Good examples include:

  • your own demo
  • your own screenshots
  • public-domain or properly licensed materials
  • abstract mockups
  • recreated examples that do not copy surface style

Please avoid examples that expose private work, private people, private folders, or copyrighted visual assets.

Maintainer Note

Some internal workflows, private assets, advanced experiments, and unpublished materials are not included here. That is intentional.

The public version should stay readable, useful, and safe.

If this project helps you, starring the repository is appreciated. Please do not use bots, fake engagement, or automated promotion.