You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Instructions/Labs/LAB_AK_14_get-started-spec-driven-development.md
+12-10Lines changed: 12 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -231,48 +231,50 @@ Use the following steps to complete this task:
231
231
232
232
You can start a new session by selecting the **New Chat** button (the **+** icon at the top of the Chat panel). Starting a new Chat session ensures a clean context.
233
233
234
-
1. Take a moment to consider the options for running the `/speckit.constitution` command.
234
+
1. Take a moment to consider the options for running the /speckit.constitution command.
235
235
236
236
You can run the /speckit.constitution command with the following options:
237
237
238
238
- `/speckit.constitution --text "..."`: Use inline text to describe the standards, guidelines, principles, and constraints that should be included in the constitution.
239
239
- `/speckit.constitution --files ...`: Specify project documents that provide context for creating the constitution.
240
+
- `/speckit.constitution --text "..." --files ...`: Combine inline text input with project documents.
241
+
- `/speckit.constitution`: Run the command without any inputs. For brownfield projects, the workflow uses the codebase to identify standards/guidelines/requirements, and then generates a constitution.
240
242
241
-
> **NOTE**: The /speckit.constitution command can be run multiple times in the same project to refine or expand the constitution.md file. In this case, you first run the command using inline text input, and then you run it again using the stakeholder documents.
243
+
> **NOTE**: The /speckit.constitution command can be run multiple times in the same project to refine or expand the constitution.md file. Providing detailed inputs usually generates more accurate and comprehensive constitutions.
242
244
243
-
1. In the Chat view, to start a constitution workflow using inline text that provides a broad scope of general coding principles, enter the following command:
245
+
1. In the Chat view, to start a constitution workflow using inline text, enter the following command:
244
246
245
247
```plaintext
246
-
/speckit.constitution --text "Code projects emphasize security, privacy, accessibility, performance, reliability, observability, release management, documentation, dependency management, and code quality. Ensure that all principles are specific, actionable, and relevant to the project context."
248
+
/speckit.constitution --text "Code projects emphasize security, accessibility, performance, and code quality. Ensure that all principles are specific, actionable, and relevant to the project context."
247
249
```
248
250
249
-
The GitHub Spec Kit supports "greenfield" and "brownfield" project types. When running GitHub Spec Kit commands, the inputs that you specify for greenfield projects can be more impactful since there's no existing codebase.
251
+
In this case, the inline text provides high-level guidance for creating the constitution. This approach is useful when you want to quickly establish core principles without detailed project documents.
250
252
251
253
1. Monitor GitHub Copilot's response in the Chat view.
252
254
253
255
1. Take a minute to review the updated constitution.md file in the editor.
254
256
255
257
Notice that GitHub Copilot has updated the constitution.md file to include principles based on the inline text you provided. The principles should be clearly stated and actionable.
256
258
257
-
For a real-world project, it's important to review the constitution against the following criteria before saving:
259
+
For a real-world project, it's important to review the constitution against the following criteria:
258
260
259
261
- Completeness: All major areas (security, performance, quality, technical standards) are covered.
260
262
- Clarity: Each principle is specific and unambiguous.
261
263
- Consistency: Principles don't contradict each other.
262
264
- Relevance: All principles relate to the RSSFeedReader project.
263
265
264
-
1. If the `/speckit.constitution` command updated files in the **templates** folder, take a minute to review those files as well.
266
+
1. If the /speckit.constitution workflow updated files in the **templates** folder, take a minute to review those files as well.
265
267
266
-
The constitution workflow might update the templates for other GitHub Spec Kit files (spec.md, plan.md, tasks.md). The updates should reflect the principles defined in the constitution.md file.
268
+
The constitution workflow can update the templates for other GitHub Spec Kit files (spec.md, plan.md, tasks.md). The updates should reflect the principles defined in the constitution.md file. This helps to ensure consistency across all project documentation.
267
269
268
270
1. To accept the changes to all updated files, select the **Keep** button in the Chat view.
269
271
270
-
You can also accept changes to individual files, or individual changes within a file, by selecting a **Keep** button in the editor.
272
+
You can also accept changes to individual files, or individual changes within a file, by selecting **Keep** button options in the editor.
271
273
272
274
1. In the Chat view, to start a second constitution workflow using the stakeholder documents, enter the following command:
0 commit comments