Skip to content

contributing.md

Latest commit

 

History

History
73 lines (49 loc) · 3.63 KB

contributing.md

File metadata and controls

73 lines (49 loc) · 3.63 KB
Raw

Contribution Guidelines

English · 简体中文

Thanks for helping make this the most complete collection of what people build with Jev. By contributing you agree to follow the Code of Conduct.

What belongs here

Anything real that uses Jev, TypeSafe's System One model, or helps people use it:

  • Projects, apps, demos, and experiments, including posts on X, Reddit, or Hacker News that show something built.
  • Integrations, SDKs, and open models that are compatible with Jev.
  • Tutorials, benchmarks, case studies, talks, and videos.

Not accepted:

  • Other people's lists and directories. Link the original project instead.
  • Pure news rewrites, marketing pages, and look-alike sites that pretend to be official.
  • Anything that leaks API keys or private data.

The two rules

  1. Link the original. The link must point to the project's own repository, app, post, article, or video. Never link another awesome list or directory; the build fails if you do.
  2. Say what it does. One or two plain sentences: what it is, what it does, and, if you know, how it uses Jev (which primitive or pattern).

How to add an entry

The READMEs and all gallery pages are generated. Do not edit README.md, README.zh-CN.md, scenarios/, pages/, or zh-CN/ by hand.

  1. Pick the scenario file in data/, for example data/finance.yaml or data/coding.yaml. Use data/other.yaml if nothing fits.

  2. Add an entry:

    - name: jev-ultrafast
  url: https://github.com/browser-use/jev-ultrafast
  kind: repo            # repo, app, post, reddit, thread, video, article, model, package, docs
  author: browser-use
  description: Browser agent that picks each step's action from the page's element table in one request.
  jev: One Choice per step with speculative targets per operation.   # optional
  image: https://raw.githubusercontent.com/owner/repo/main/screenshot.png   # optional
  metrics: {stars: 14484}   # optional: stars, likes, points, views, or downloads
  date: 2026-09-16          # optional: when it was published
  links: {demo: https://x.com/user/status/123}   # optional secondary links

  3. Open a pull request. Editing the YAML file right on GitHub is fine; one project per pull request is easiest to review.

After a pull request is merged, a GitHub Action regenerates the READMEs, the gallery pages, and the website (https://li-evan.github.io/awesome-jev/) from data/. Running uv run scripts/build.py locally is optional and only needed if you want to preview the result. description_zh (a Chinese description) is optional; the Chinese pages fall back to the English text.

Badge for listed projects

If your project is listed, you are welcome to show it:

[![Mentioned in Awesome Jev](https://awesome.re/mentioned-badge.svg)](https://github.com/Li-Evan/awesome-jev)

Images

  • Use an image from the project's own pages: a screenshot in its README, its og:image, the media in the original post, or the video thumbnail.
  • Link the image where it lives; do not upload copies to this repository.
  • Prefer PNG, JPEG, or WebP. Skip animated GIFs larger than about 3 MB.
  • Without an image, GitHub repositories and YouTube videos fall back to their automatic preview card.

Description style

  • Start with a capital letter and end with a period.
  • Describe the thing, not the hype: "Classifies IRS form pages with two Choices" beats "Revolutionary AI tax tool".
  • Keep any number you quote identical to the source.

Updating or removing

If a link is broken, a project is gone, or a description is wrong, open an issue or a pull request with a short explanation.