Foundations
Project initiation template
Turn a new or existing software idea into a structured, documented project.
- Format
- Markdown
- Length
- 371 words
- Read
- ~2 min
Source
Markdown
## Windsurf project init template
**
[https://www.reddit.com/r/Codeium/comments/1h2psgy/windsurf_best_practices/](https://www.reddit.com/r/Codeium/comments/1h2psgy/windsurf_best_practices/)
Windsurf project docs
Windsurf global rules, short commit message: (from: )
```md
Write a short english commit message (maximum one sentence) for every change you make, and always format it in a code block. Use the following guidelines for consistent and descriptive commit messages:
prefix: short description (maximum one sentence)
Commit Prefixes:
- feat: Introduce a new feature.
- fix: Fix a bug or issue.
- tweak: Make minor adjustments or improvements.
- style: Update code style or formatting.
- refactor: Restructure code without changing functionality.
- perf: Improve performance or efficiency.
- test: Add or update tests.
- docs: Update documentation.
- chore: Perform maintenance tasks or updates.
- ci: Change CI/CD configuration.
- build: Modify build system or dependencies.
- revert: Revert a previous commit.
- hotfix: Apply an urgent bug fix.
- init: Initialize a new project or feature.
- merge: Merge branches.
- wip: Mark work in progress.
- release: Prepare for a release.
```
## prompt for existing projects
@. Fill the following template with the details from the project dir and save as CLAUDE.md in the root of the project:
```md
---- START INIT TEMPLATE ----
I'm working on [project name]. Here are the key documents to help you understand the current state and context:
- Main PRD: @[/docs/01-PRD.md](
/docs/01-PRD.md
) - Core vision, values, and high-level requirements
- Community Features: @[/docs/prd-community.md](
/docs/prd-community.md
) - Community tab and social features
- Support Features: @[/docs/prd-support.md](
/docs/prd-support.md
) - Professional support and resources
- Progress Features: @[/docs/prd-progress.md](
/docs/prd-progress.md
) - Progress tracking and analytics
1. Current Status & Priorities:
- START HERE: @[/docs/00-START-HERE.md](
/docs/00-START-HERE.md
)
2. PRDs + Technical Specs:
- Master PRD: @[docs/01-PRD.md](
/docs/01-PRD.md
) - Overall project vision
- Community Features PRD: @[docs/prd-community.md](
/docs/prd-community.md
)
- Support Features PRD: @[docs/prd-support.md](
/docs/prd-support.md
)
- Progress Features PRD: @[docs/prd-progress.md](
/docs/prd-progress.md
)
- Design System: @[docs/02-DESIGN.md](
/docs/02-DESIGN.md
)
1. Main Implementation Directories:
- iOS App: @[RecoveryCoach](
/RecoveryCoach
)
- Project Name: @[project-name](
/project-name
)
- README: @[project-name/README.md](
/project-name/README.md
)
Based on the current sprint status in START HERE, please do the following:
- Suggest scope of this working session (what to work on next)
---- END INIT TEMPLATE ----
```