Skip to content

Commit fa52889

Browse files
committed
Reformat README
1 parent 036022d commit fa52889

File tree

1 file changed

+37
-7
lines changed

1 file changed

+37
-7
lines changed

README.md

Lines changed: 37 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,27 @@
1-
# Modernize your legacy code with GitHub Copilot
1+
# Modernize Your Legacy Code with GitHub Copilot (SpecOps Edition)
22

33
<img src="https://octodex.github.com/images/Professortocat_v2.png" align="right" height="200px" />
44

5-
> **Note:** This is an adaptation of the [original GitHub Skills lesson](https://github.com/skills/modernize-your-legacy-code-with-github-copilot) that has been modified to demonstrate [SpecOps](https://spec-ops.ai) principles. SpecOps is a methodology for using AI to modernize legacy systems by focusing on **knowledge preservation and verified specifications** rather than direct code translation. In this adapted lesson, you'll learn to create a comprehensive software specification from legacy COBOL code before generating a modern Node.js implementation.
5+
> **Note:** This is an adaptation of the [original GitHub Skills lesson](https://github.com/skills/modernize-your-legacy-code-with-github-copilot) that has been modified to demonstrate [SpecOps](https://spec-ops.ai) principles. SpecOps is a methodology for using AI to modernize legacy systems by focusing on **knowledge preservation and verified specifications** rather than direct code translation.
6+
7+
## Welcome
8+
9+
- **Who is this for**: Developers looking to update and improve their legacy codebases using specification-driven development.
10+
- **What you'll learn**: How to leverage GitHub Copilot to extract specifications from legacy code and generate modern implementations from those specifications.
11+
- **What you'll build**: A software specification and a modern Node.js application that implements it.
12+
- **Prerequisites**:
13+
- Skills exercise: [Getting Started with GitHub Copilot](https://github.com/skills/getting-started-with-github-copilot)
14+
- Familiarity with [VS Code](https://code.visualstudio.com/)
15+
- Basic coding principles
16+
- **How long**: This exercise takes less than 30 minutes to complete.
17+
18+
In this exercise, you will:
19+
20+
1. Analyze legacy COBOL code to understand its behavior.
21+
2. **Generate a software specification** that captures business rules in plain language.
22+
3. Create a test plan derived from the specification.
23+
4. **Implement a modern Node.js application from the specification**—not by translating code.
24+
5. Validate the implementation against the specification using tests.
625

726
## SpecOps Toolkit
827

@@ -13,15 +32,26 @@ This repository includes standard SpecOps components that you can reuse in your
1332
| [AGENTS.md](AGENTS.md) | Instructions for AI agents working on this codebase. Encodes the SpecOps methodology—specification-driven development where the spec is the source of truth. Configure this file to guide AI assistants in your own projects. |
1433
| [.github/workflows/spec-change-issues.yml](.github/workflows/spec-change-issues.yml) | GitHub Actions workflow using the [SpecOps Action](https://github.com/spec-ops-method/spec-ops-action) to automatically create issues when specification files are modified. This ensures spec changes generate trackable work items for implementation review. |
1534

16-
---
35+
### How to start this exercise
36+
37+
Simply copy the exercise to your account, then give your favorite Octocat (Mona) **about 20 seconds** to prepare the first lesson, then **refresh the page**.
38+
39+
[![Start the exercise](https://img.shields.io/badge/Copy%20Exercise-%E2%86%92-1f883d?style=for-the-badge&logo=github&labelColor=197935)](https://github.com/new?template_owner=spec-ops-method&template_name=modernize-your-legacy-code-with-github-copilot&owner=%40me&name=specops-modernize-legacy-code&description=Exercise:+Modernize+Your+Legacy+Code+with+GitHub+Copilot+(SpecOps+Edition)&visibility=public)
40+
41+
<details>
42+
<summary>Having trouble? 🤷</summary><br/>
43+
44+
When copying the exercise, we recommend the following settings:
1745

18-
Hey mheadd!
46+
- For owner, choose your personal account or an organization to host the repository.
47+
- We recommend creating a public repository, since private repositories will use Actions minutes.
1948

20-
Mona here. I'm done preparing your exercise. Hope you enjoy! 💚
49+
If the exercise isn't ready in 20 seconds, please check the [Actions](../../actions) tab.
2150

22-
Remember, it's self-paced so feel free to take a break! ☕️
51+
- Check to see if a job is running. Sometimes it simply takes a bit longer.
52+
- If the page shows a failed job, please submit an issue. Nice, you found a bug! 🐛
2353

24-
[![](https://img.shields.io/badge/Go%20to%20Exercise-%E2%86%92-1f883d?style=for-the-badge&logo=github&labelColor=197935)](https://github.com/spec-ops-method/modernize-your-legacy-code-with-github-copilot/issues/1)
54+
</details>
2555

2656
---
2757

0 commit comments

Comments
 (0)