Skip to content

ubugeeei/start

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

start

Default technology selection and engineering rules for AI-assisted project creation.

What is this?

A set of opinionated guidelines that AI agents follow when scaffolding new projects. Covers stack choices, tooling defaults, code style, and CI/CD conventions.

Key Principles

  • Predictable tooling with a single stack-appropriate task entry point
  • Minimal incidental complexity
  • Strong static guarantees
  • Small, focused modules
  • Implementations capped at 250 lines and split by responsibility
  • Avoid unnecessary allocations, copies, and convenience abstractions
  • In Rust, prefer SmallVec, CompactString, and memchr where they fit
  • Low allocation overhead where performance matters

Repository Conventions

  • Place Rust crates under ./crates.
  • Place TypeScript packages under ./npm.
  • Place examples under ./examples.
  • For Rust to JavaScript or Node.js interop, use napi-rs.
  • Use snake_case for directory names and file names.
  • Keep each implementation unit at 250 lines or fewer.
  • Split files before responsibilities begin to mix.

Usage

Fetch individual guideline files via the GitHub API:

# Tech selection overview
gh api repos/ubugeeei/start/contents/docs/general.md --jq '.content' | base64 -d

# TypeScript
gh api repos/ubugeeei/start/contents/docs/typescript.md --jq '.content' | base64 -d

# Rust
gh api repos/ubugeeei/start/contents/docs/rust.md --jq '.content' | base64 -d

# Vue
gh api repos/ubugeeei/start/contents/docs/vue.md --jq '.content' | base64 -d

Local Development

Use nix for the local toolchain in this repository.

nix develop
vp install
vp fmt

The dev shell provides Node.js 24 and pnpm 10. The project guidelines continue to standardize shared project tasks on Vite Task via vp and vp run.

License

MIT

About

The initial prompts for my projects (Rust, TypeScript, Vue)

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages