mirror of
https://github.com/documenso/documenso
synced 2026-04-21 21:37: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
104 lines
4.8 KiB
Markdown
104 lines
4.8 KiB
Markdown
# Contributing to Documenso
|
|
|
|
If you plan to contribute to Documenso, please take a moment to feel awesome ✨ People like you are what open source is about ♥. Any contributions, no matter how big or small, are highly appreciated.
|
|
|
|
## Before getting started
|
|
|
|
- Before jumping into a PR be sure to search [existing PRs](https://github.com/documenso/documenso/pulls) or [issues](https://github.com/documenso/documenso/issues) for an open or closed item that relates to your submission.
|
|
- Select an issue from [here](https://github.com/documenso/documenso/issues) or create a new one
|
|
- Consider the results from the discussion on the issue
|
|
- Accept the [Contributor License Agreement](https://documen.so/cla) to ensure we can accept your contributions.
|
|
|
|
## Taking issues
|
|
|
|
Before taking an issue, ensure that:
|
|
|
|
- The issue has been assigned the public label
|
|
- The issue is clearly defined and understood
|
|
- No one has been assigned to the issue
|
|
- No one has expressed intention to work on it
|
|
|
|
You can then:
|
|
|
|
1. Comment on the issue with your intention to work on it
|
|
2. Begin work on the issue
|
|
|
|
Always feel free to ask questions or seek clarification on the issue.
|
|
|
|
## Developing
|
|
|
|
The development branch is <code>main</code>. All pull requests should be made against this branch. If you need help getting started, [join us on Discord](https://documen.so/discord).
|
|
|
|
1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your
|
|
own GitHub account and then
|
|
[clone](https://help.github.com/articles/cloning-a-repository/) it to your local device.
|
|
2. Create a new branch:
|
|
|
|
- Create a new branch (include the issue id and something readable):
|
|
|
|
```sh
|
|
git checkout -b feat/doc-999-somefeature-that-rocks
|
|
```
|
|
|
|
3. See the [Developer Setup](https://github.com/documenso/documenso/blob/main/README.md#developer-setup) for more setup details.
|
|
|
|
## Building
|
|
|
|
> **Note**
|
|
> Please ensure you can make a full production build before pushing code or creating PRs.
|
|
|
|
You can build the project with:
|
|
|
|
```bash
|
|
npm run build
|
|
```
|
|
|
|
## AI-Assisted Development with OpenCode
|
|
|
|
We use [OpenCode](https://opencode.ai) for AI-assisted development. OpenCode provides custom commands and skills to help maintain consistency and streamline common workflows.
|
|
|
|
OpenCode works with most major AI providers (Anthropic, OpenAI, Google, etc.) or you can use [Zen](https://opencode.ai/zen) for optimized coding models. Configure your preferred provider in the OpenCode settings.
|
|
|
|
> **Important**: All AI-generated code must be thoroughly reviewed by the contributor before submitting a PR. You are responsible for understanding and validating every line of code you submit. If we detect that contributors are simply throwing AI-generated code over the wall without proper review, they will be blocked from the repository.
|
|
|
|
### Getting Started
|
|
|
|
1. Install OpenCode (see [opencode.ai](https://opencode.ai) for other install methods):
|
|
```bash
|
|
curl -fsSL https://opencode.ai/install | bash
|
|
```
|
|
2. Configure your AI provider (or use Zen for optimized models)
|
|
3. Run `opencode` in the project root
|
|
|
|
### Available Commands
|
|
|
|
Use these commands in OpenCode by typing the command name:
|
|
|
|
| Command | Description |
|
|
| ------------------------------ | -------------------------------------------------------- |
|
|
| `/implement <spec-path>` | Implement a spec from `.agents/plans/` autonomously |
|
|
| `/continue <spec-path>` | Continue implementing a spec from a previous session |
|
|
| `/interview <file-path>` | Deep-dive interview to flesh out a spec or design |
|
|
| `/document <module-path>` | Generate MDX documentation for a module or feature |
|
|
| `/commit` | Create a conventional commit for staged changes |
|
|
| `/create-plan <slug>` | Create a new plan file in `.agents/plans/` |
|
|
| `/create-scratch <slug>` | Create a scratch file for notes in `.agents/scratches/` |
|
|
| `/create-justification <slug>` | Create a justification file in `.agents/justifications/` |
|
|
|
|
### Typical Workflow
|
|
|
|
1. **Create a plan**: Use `/create-plan my-feature` to draft a spec for a new feature
|
|
2. **Flesh out the spec**: Use `/interview .agents/plans/<file>.md` to refine requirements
|
|
3. **Implement**: Use `/implement .agents/plans/<file>.md` to build the feature
|
|
4. **Continue if needed**: Use `/continue .agents/plans/<file>.md` to pick up where you left off
|
|
5. **Commit**: Use `/commit` to create a conventional commit
|
|
|
|
### Agent Files
|
|
|
|
The `.agents/` directory stores AI-generated artifacts:
|
|
|
|
- **`.agents/plans/`** - Feature specs and implementation plans
|
|
- **`.agents/scratches/`** - Temporary notes and explorations
|
|
- **`.agents/justifications/`** - Decision rationale and technical justifications
|
|
|
|
These files use a unique ID format (`{word}-{word}-{word}-{slug}.md`) to prevent conflicts.
|