Skip to content

Commit 2be8ef2

Browse files
committed
updated ex14 resources
1 parent 8329bb9 commit 2be8ef2

5 files changed

Lines changed: 12 additions & 10 deletions

File tree

DownloadableCodeProjects/standalone-lab-projects/sdd-get-started-rss-feed/StakeholderDocuments/App_Features.md renamed to DownloadableCodeProjects/standalone-lab-projects/sdd-get-started-rss-feed/StakeholderDocuments/AppFeatures.md

File renamed without changes.

DownloadableCodeProjects/standalone-lab-projects/sdd-get-started-rss-feed/StakeholderDocuments/MVP_System_Rules.md renamed to DownloadableCodeProjects/standalone-lab-projects/sdd-get-started-rss-feed/StakeholderDocuments/MVPSystemRules.md

File renamed without changes.

DownloadableCodeProjects/standalone-lab-projects/sdd-get-started-rss-feed/StakeholderDocuments/Project_Goals.md renamed to DownloadableCodeProjects/standalone-lab-projects/sdd-get-started-rss-feed/StakeholderDocuments/ProjectGoals.md

File renamed without changes.

DownloadableCodeProjects/standalone-lab-projects/sdd-get-started-rss-feed/StakeholderDocuments/Tech_Stack.md renamed to DownloadableCodeProjects/standalone-lab-projects/sdd-get-started-rss-feed/StakeholderDocuments/TechStack.md

File renamed without changes.

Instructions/Labs/LAB_AK_14_get-started-spec-driven-development.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -231,48 +231,50 @@ Use the following steps to complete this task:
231231
232232
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.
233233
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.
235235
236236
You can run the /speckit.constitution command with the following options:
237237
238238
- `/speckit.constitution --text "..."`: Use inline text to describe the standards, guidelines, principles, and constraints that should be included in the constitution.
239239
- `/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.
240242
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.
242244
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:
244246
245247
```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."
247249
```
248250
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.
250252
251253
1. Monitor GitHub Copilot's response in the Chat view.
252254
253255
1. Take a minute to review the updated constitution.md file in the editor.
254256
255257
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.
256258
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:
258260
259261
- Completeness: All major areas (security, performance, quality, technical standards) are covered.
260262
- Clarity: Each principle is specific and unambiguous.
261263
- Consistency: Principles don't contradict each other.
262264
- Relevance: All principles relate to the RSSFeedReader project.
263265
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.
265267
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.
267269
268270
1. To accept the changes to all updated files, select the **Keep** button in the Chat view.
269271
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.
271273
272274
1. In the Chat view, to start a second constitution workflow using the stakeholder documents, enter the following command:
273275
274276
```plaintext
275-
/speckit.constitution --files StakeholderDocuments/Project\ Goals.md StakeholderDocuments/App\ Features.md StakeholderDocuments/Tech\ Stack.md StakeholderDocuments/MVP\ System\ Rules.md
277+
/speckit.constitution --files StakeholderDocuments/ProjectGoals.md StakeholderDocuments/AppFeatures.md StakeholderDocuments/TechStack.md StakeholderDocuments/MVPSystemRules.md
276278
```
277279
278280
1. Monitor GitHub Copilot's response.

0 commit comments

Comments
 (0)