Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
76 lines (49 loc) · 2.84 KB

CONTRIBUTING.md

File metadata and controls

76 lines (49 loc) · 2.84 KB

Contributing to HUMANTODO

Thanks for your interest in contributing to HUMANTODO! This document covers how to set up the project locally and the different ways you can contribute.

What is HUMANTODO?

HUMANTODO is a concept. The core idea is simple: when AI agents write code, they should intentionally leave critical parts for the human to complete - one example would be mark with // HUMANTODO: comments. Think of it as the IKEA effect for coding.

The website (humantodo.dev) explains the concept and provides a few starter examples.

But these are just two implementations. HUMANTODO can be applied in many different ways, and you can contribute or implement your own implementations!

If you have an implementation or idea, open an issue or submit a PR. It doesn't need to live in this repo — linking to your own project is great too.

Project setup

Prerequisites

Tip

If you use mise, run mise install in the project root and the correct versions of Node and pnpm will be set up automatically.

Getting started

git clone https://github.com/nichochar/humantodo.git
cd humantodo

pnpm install

pnpm dev

The site will be available at http://localhost:4321.

Available scripts

Command Description
pnpm dev Start the Astro dev server
pnpm build Build the site for production
pnpm preview Build and preview with Wrangler (Cloudflare)
pnpm lint Run ESLint
pnpm format Format code with Prettier
pnpm format:check Check formatting without writing
pnpm typecheck Run astro check for type errors

Git hooks

The project uses Lefthook for git hooks. On pre-push, the following checks run in parallel:

  • pnpm lint
  • pnpm format:check
  • pnpm typecheck

Lefthook is installed as a dev dependency, so hooks are set up automatically after pnpm install.

Tech stack

Submitting changes

  1. Fork the repo and create a branch from main.
  2. Make your changes.
  3. Make sure pnpm lint, pnpm format:check, and pnpm typecheck all pass.
  4. Open a pull request with a clear description of what you changed and why.

License

This project is licensed under the MIT License.