mirror of
https://github.com/documenso/documenso
synced 2026-04-21 13:27:18 +00:00
34f512bd55
Adds OpenCode support for AI-assisted development, including custom commands and skills to help contributors maintain consistency and streamline common workflows. #### Changes - Added "AI-Assisted Development with OpenCode" section to CONTRIBUTING.md with: - Installation instructions and provider configuration - Documentation for 8 custom commands (/implement, /continue, /interview, /document, /commit, /create-plan, /create-scratch, /create-justification) - Typical workflow guide - Clear policy that AI-generated code must be reviewed before submission - Added .agents/ directory for plans, scratches, and justifications - Added .opencode/ commands and skills for the agent - Added helper scripts for creating agent files
75 lines
1.7 KiB
Markdown
75 lines
1.7 KiB
Markdown
---
|
|
description: Create a new scratch file in .agents/scratches/
|
|
argument-hint: <scratch-slug> [content]
|
|
---
|
|
|
|
You are creating a new scratch file in the `.agents/scratches/` directory.
|
|
|
|
## Your Task
|
|
|
|
1. **Determine the slug** - Use `$ARGUMENTS` as the file slug (kebab-case recommended)
|
|
2. **Gather content** - Collect or generate the scratch content
|
|
3. **Create the file** - Use the create-scratch script to generate the file
|
|
|
|
## Usage
|
|
|
|
The script will automatically:
|
|
- Generate a unique three-word ID (e.g., `calm-teal-cloud`)
|
|
- Create frontmatter with current date and formatted title
|
|
- Save the file as `{id}-{slug}.md` in `.agents/scratches/`
|
|
|
|
## Creating the File
|
|
|
|
### Option 1: Direct Content
|
|
|
|
If you have the content ready, run:
|
|
|
|
```bash
|
|
npx tsx scripts/create-scratch.ts "$ARGUMENTS" "Your scratch content here"
|
|
```
|
|
|
|
### Option 2: Multi-line Content (Heredoc)
|
|
|
|
For multi-line content, use heredoc:
|
|
|
|
```bash
|
|
npx tsx scripts/create-scratch.ts "$ARGUMENTS" << HEREDOC
|
|
Your multi-line
|
|
scratch content
|
|
goes here
|
|
HEREDOC
|
|
```
|
|
|
|
### Option 3: Pipe Content
|
|
|
|
You can also pipe content:
|
|
|
|
```bash
|
|
echo "Your content" | npx tsx scripts/create-scratch.ts "$ARGUMENTS"
|
|
```
|
|
|
|
## File Format
|
|
|
|
The created file will have:
|
|
|
|
```markdown
|
|
---
|
|
date: 2026-01-13
|
|
title: Scratch Title
|
|
---
|
|
|
|
Your content here
|
|
```
|
|
|
|
The title is automatically formatted from the slug (e.g., `quick-notes` → `Quick Notes`).
|
|
|
|
## Guidelines
|
|
|
|
- Use descriptive slugs in kebab-case (e.g., `exploration-ideas`, `temporary-notes`)
|
|
- Scratch files are for temporary notes, explorations, or ideas
|
|
- The unique ID ensures no filename conflicts
|
|
- Files are automatically dated for organization
|
|
|
|
## Begin
|
|
|
|
Create a scratch file using the slug from `$ARGUMENTS` and appropriate content for notes or exploration.
|