Compare commits

..

6 Commits

Author SHA1 Message Date
Den Delimarsky
e566e90708 Merge pull request #94 from paullen/patch-1
Update README.md
2025-09-08 18:37:10 -07:00
Bitan Paul
a3b6e4455a Update README.md
Correct grammar in /specify example for better clarity
2025-09-09 05:39:54 +05:30
Den Delimarsky
3259b845ed Merge pull request #85 from github/update-readme
README consistency
2025-09-08 13:18:10 -07:00
Den Delimarsky 🌺
9d01e9d7b6 Update README.md 2025-09-08 13:16:38 -07:00
Den Delimarsky
e786a9df64 Merge pull request #70 from azuma317/cleanup/tasks-template-whitespace
Remove trailing whitespace from tasks.md template
2025-09-08 09:18:59 -07:00
azuma
51b8459122 Remove trailing whitespace from tasks.md template 2025-09-08 11:57:53 +09:00
2 changed files with 15 additions and 11 deletions

View File

@@ -21,8 +21,12 @@
- [🎯 Experimental goals](#-experimental-goals) - [🎯 Experimental goals](#-experimental-goals)
- [🔧 Prerequisites](#-prerequisites) - [🔧 Prerequisites](#-prerequisites)
- [📖 Learn more](#-learn-more) - [📖 Learn more](#-learn-more)
- [Detailed process](#detailed-process) - [📋 Detailed process](#-detailed-process)
- [Troubleshooting](#troubleshooting) - [🔍 Troubleshooting](#-troubleshooting)
- [👥 Maintainers](#-maintainers)
- [💬 Support](#-support)
- [🙏 Acknowledgements](#-acknowledgements)
- [📄 License](#-license)
## 🤔 What is Spec-Driven Development? ## 🤔 What is Spec-Driven Development?
@@ -43,7 +47,7 @@ uvx --from git+https://github.com/github/spec-kit.git specify init <PROJECT_NAME
Use the `/specify` command to describe what you want to build. Focus on the **what** and **why**, not the tech stack. Use the `/specify` command to describe what you want to build. Focus on the **what** and **why**, not the tech stack.
```bash ```bash
/specify Build an application that can help me organize my photos in separate photo albums. Albums are grouped by date and can be re-organized by dragging and dropping on the main page. Albums never other nested albums. Within each album, photos are previewed in a tile-like interface. /specify Build an application that can help me organize my photos in separate photo albums. Albums are grouped by date and can be re-organized by dragging and dropping on the main page. Albums are never in other nested albums. Within each album, photos are previewed in a tile-like interface.
``` ```
### 3. Create a technical implementation plan ### 3. Create a technical implementation plan
@@ -118,7 +122,7 @@ Our research and experimentation focus on:
--- ---
## Detailed process ## 📋 Detailed process
<details> <details>
<summary>Click to expand the detailed step-by-step walkthrough</summary> <summary>Click to expand the detailed step-by-step walkthrough</summary>
@@ -341,7 +345,7 @@ Once the implementation step is done, ask Claude Code to try to run the applicat
--- ---
## Troubleshooting ## 🔍 Troubleshooting
### Git Credential Manager on Linux ### Git Credential Manager on Linux
@@ -360,19 +364,19 @@ echo "Cleaning up..."
rm gcm-linux_amd64.2.6.1.deb rm gcm-linux_amd64.2.6.1.deb
``` ```
## Maintainers ## 👥 Maintainers
- Den Delimarsky ([@localden](https://github.com/localden)) - Den Delimarsky ([@localden](https://github.com/localden))
- John Lam ([@jflam](https://github.com/jflam)) - John Lam ([@jflam](https://github.com/jflam))
## Support ## 💬 Support
For support, please open a [GitHub issue](https://github.com/github/spec-kit/issues/new). We welcome bug reports, feature requests, and questions about using Spec-Driven Development. For support, please open a [GitHub issue](https://github.com/github/spec-kit/issues/new). We welcome bug reports, feature requests, and questions about using Spec-Driven Development.
## Acknowledgements ## 🙏 Acknowledgements
This project is heavily influenced by and based on the work and research of [John Lam](https://github.com/jflam). This project is heavily influenced by and based on the work and research of [John Lam](https://github.com/jflam).
## License ## 📄 License
This project is licensed under the terms of the MIT open source license. Please refer to the [LICENSE](./LICENSE) file for the full terms. This project is licensed under the terms of the MIT open source license. Please refer to the [LICENSE](./LICENSE) file for the full terms.

View File

@@ -13,10 +13,10 @@ Given the context provided as an argument, do this:
2. Load and analyze available design documents: 2. Load and analyze available design documents:
- Always read plan.md for tech stack and libraries - Always read plan.md for tech stack and libraries
- IF EXISTS: Read data-model.md for entities - IF EXISTS: Read data-model.md for entities
- IF EXISTS: Read contracts/ for API endpoints - IF EXISTS: Read contracts/ for API endpoints
- IF EXISTS: Read research.md for technical decisions - IF EXISTS: Read research.md for technical decisions
- IF EXISTS: Read quickstart.md for test scenarios - IF EXISTS: Read quickstart.md for test scenarios
Note: Not all projects have all documents. For example: Note: Not all projects have all documents. For example:
- CLI tools might not have contracts/ - CLI tools might not have contracts/
- Simple libraries might not need data-model.md - Simple libraries might not need data-model.md