template-instructions 1.0.1 → 1.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (28) hide show
  1. package/{instructions → .gemini/instructions}/global.md +8 -2
  2. package/{instructions → .gemini/instructions}/usage.md +1 -0
  3. package/README.md +47 -12
  4. package/bin/cli.js +2 -2
  5. package/package.json +1 -1
  6. /package/{instructions → .gemini/instructions}/roles/designer.md +0 -0
  7. /package/{instructions → .gemini/instructions}/roles/dev.md +0 -0
  8. /package/{instructions → .gemini/instructions}/roles/devops.md +0 -0
  9. /package/{instructions → .gemini/instructions}/roles/pm.md +0 -0
  10. /package/{instructions → .gemini/instructions}/roles/po.md +0 -0
  11. /package/{instructions → .gemini/instructions}/roles/qa.md +0 -0
  12. /package/{instructions → .gemini/instructions}/roles/reporter.md +0 -0
  13. /package/{instructions → .gemini/instructions}/roles/sa.md +0 -0
  14. /package/{instructions → .gemini/instructions}/roles/seca.md +0 -0
  15. /package/{instructions → .gemini/instructions}/roles/stakeholder.md +0 -0
  16. /package/{instructions → .gemini/instructions}/roles/tester.md +0 -0
  17. /package/{instructions → .gemini/instructions}/templates/Backend-Design-Spec-Template.md +0 -0
  18. /package/{instructions → .gemini/instructions}/templates/Design-Verification-Report-Template.md +0 -0
  19. /package/{instructions → .gemini/instructions}/templates/DevOps-Plan-Template.md +0 -0
  20. /package/{instructions → .gemini/instructions}/templates/Development-Log-Template.md +0 -0
  21. /package/{instructions → .gemini/instructions}/templates/Final-Approval-Report-Template.md +0 -0
  22. /package/{instructions → .gemini/instructions}/templates/Phase-Report-Template.md +0 -0
  23. /package/{instructions → .gemini/instructions}/templates/Product-Backlog-Template.md +0 -0
  24. /package/{instructions → .gemini/instructions}/templates/Project-Plan-Template.md +0 -0
  25. /package/{instructions → .gemini/instructions}/templates/Security-Review-Report-Template.md +0 -0
  26. /package/{instructions → .gemini/instructions}/templates/Test-Report-Template.md +0 -0
  27. /package/{instructions → .gemini/instructions}/templates/definition-of-done.md +0 -0
  28. /package/{instructions → .gemini/instructions}/templates/incident-response.md +0 -0
@@ -194,8 +194,14 @@ Handled by REPORTER or STAKEHOLDER when:
194
194
  - Use screenshots, recordings, or browser artifacts for proof
195
195
  - All agents must produce verifiable artifacts (logs, reports, diagrams)
196
196
 
197
- ### 9. Completion Criteria
198
- Project is complete ONLY when:
197
+ ### 10. Mandatory Reporting
198
+ After completing any task or phase, the role **MUST** create the corresponding report file as specified in the Artifact Naming Convention. This ensures full traceability and audit trail.
199
+
200
+ - **No task is considered complete without its artifact.**
201
+ - Artifacts must be placed in the exact folder structure: `docs/sprints/sprint-[N]/[category]/`
202
+ - Use version numbers (v1, v2, etc.) for revisions.
203
+
204
+ ### 11. Completion Criteria
199
205
  - ✅ STAKEHOLDER approves
200
206
  - ✅ No critical/high bugs remain
201
207
  - ✅ All Must-Have features delivered and verified
@@ -178,6 +178,7 @@ Artifacts are organized by type in the `docs/` folder:
178
178
  - Provide clear approval before phase transitions
179
179
  - Use correct tags to invoke roles
180
180
  - Review generated artifacts
181
+ - **Create and save the required report file after completing any task**
181
182
 
182
183
  ### ❌ DON'T:
183
184
  - Skip phases (e.g., coding before design approval)
package/README.md CHANGED
@@ -44,20 +44,55 @@ Instead of one "generic" AI trying to do everything, you get specialized experts
44
44
  - Optimized for iterative development.
45
45
  - Keeps files organized by Sprint (`docs/sprints/sprint-X/`), preventing clutter and ensuring version control.
46
46
 
47
+ ## � Installation
48
+
49
+ ### Prerequisites
50
+ - Node.js (version 14 or higher)
51
+ - npm or yarn
52
+
53
+ ### Install the CLI Tool
54
+ ```bash
55
+ npm install -g template-instructions
56
+ ```
57
+
58
+ ### Create a New Project with Instructions
59
+ ```bash
60
+ create-instructions my-sdlc-project
61
+ ```
62
+
63
+ This will create a new folder `my-sdlc-project` containing a `.gemini/instructions` folder with all the instruction files and templates.
64
+
65
+ ### Manual Setup
66
+ Alternatively, clone this repository and copy the `.gemini/instructions/` folder to your desired location.
67
+
68
+ ## 🔧 Setup with Gemini
69
+
70
+ 1. Copy the instruction files to your Gemini workspace:
71
+ ```bash
72
+ cp -r .gemini/instructions/ ~/.gemini/instructions/
73
+ ```
74
+ (Or manually copy the `.gemini/instructions/` folder to `.gemini/instructions/` in your project.)
75
+
76
+ 2. Ensure your Gemini configuration points to this instructions directory.
77
+
47
78
  ## 📁 Repository Structure
48
79
 
49
80
  ```
50
81
  .
51
- ├── instructions/
52
- ├── global.md # Mandatory global rules and SDLC workflows
53
- ├── usage.md # Detailed usage guide and examples
54
- ├── roles/ # Role-specific instruction definitions
55
- ├── pm.md, po.md, sa.md... # (PM, PO, SA, UIUX, QA, etc.)
56
- └── templates/ # Standardized document templates
57
- │ ├── Project-Plan-Template.md
58
- │ ├── Product-Backlog-Template.md
59
- │ └── ...
60
- └── README.md # This file
82
+ ├── bin/
83
+ └── cli.js # CLI tool for scaffolding new projects
84
+ ├── .gemini/
85
+ └── instructions/
86
+ ├── global.md # Mandatory global rules and SDLC workflows
87
+ ├── usage.md # Detailed usage guide and examples
88
+ │ ├── roles/ # Role-specific instruction definitions
89
+ ├── pm.md, po.md, sa.md... # (PM, PO, SA, UIUX, QA, etc.)
90
+ │ └── templates/ # Standardized document templates
91
+ │ ├── Project-Plan-Template.md
92
+ │ ├── Product-Backlog-Template.md
93
+ │ └── ...
94
+ ├── package.json # Project metadata and scripts
95
+ └── README.md # This file
61
96
  ```
62
97
 
63
98
  ## 🚀 Quick Start
@@ -90,8 +125,8 @@ Instead of one "generic" AI trying to do everything, you get specialized experts
90
125
 
91
126
  For detailed instructions, rules, and workflows, please refer to:
92
127
 
93
- * **[Usage Guide](instructions/usage.md)**: How to use the system, examples, and commands.
94
- * **[Global Rules](instructions/global.md)**: The strict SDLC protocols and rules every agent follows.
128
+ * **[Usage Guide](.gemini/instructions/usage.md)**: How to use the system, examples, and commands.
129
+ * **[Global Rules](.gemini/instructions/global.md)**: The strict SDLC protocols and rules every agent follows.
95
130
 
96
131
  ---
97
132
  *Maintained by the TeamLifecycle Project Team.*
package/bin/cli.js CHANGED
@@ -7,12 +7,12 @@ import { fileURLToPath } from 'url';
7
7
  const __dirname = path.dirname(fileURLToPath(import.meta.url));
8
8
  const projectName = process.argv[2] || 'my-new-project';
9
9
  const targetPath = path.join(process.cwd(), projectName);
10
- const templatePath = path.join(__dirname, '../.instructions'); // Folder containing your template files
10
+ const templatePath = path.join(__dirname, '../.gemini/instructions'); // Folder containing your template files
11
11
 
12
12
  async function scaffold() {
13
13
  try {
14
14
  console.log(`🚀 Creating project in ${targetPath}...`);
15
- await fs.copy(templatePath, targetPath);
15
+ await fs.copy(templatePath, path.join(targetPath, '.gemini'));
16
16
  console.log('✅ Project created successfully!');
17
17
  } catch (err) {
18
18
  console.error('❌ Error:', err);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "template-instructions",
3
- "version": "1.0.1",
3
+ "version": "1.1.2",
4
4
  "description": "Simulating a complete Software Development Lifecycle (SDLC) with specialized AI Agents.",
5
5
  "main": "index.js",
6
6
  "bin": {