Skip to content

Commit 8287362

Browse files
committed
Update assignment readme
1 parent 8a78d96 commit 8287362

2 files changed

Lines changed: 37 additions & 8 deletions

File tree

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
applyTo: "assignments/**/*.md"
3+
---
4+
5+
# Assignment Markdown Structure Guidelines
6+
7+
All assignment markdown files should follow these guidelines:
8+
9+
## 1. Template Usage
10+
11+
- Assignment markdown files must follow the structure in [`templates/assignment-template.md`](../../templates/assignment-template.md).
12+
- The assignment must be created as a `README.md` file
13+
- Do not remove or skip required sections from the template.
14+
15+
## 2. Section Guidance
16+
17+
The section headers should reflect the structure in the template, including the exact icon usage.
18+
19+
- **Title**: Replace `[Assignment Title]` with a short, descriptive name (e.g., `Python Basics`, `Loops and Conditionals`, `Functions and Modules`).
20+
- **Objective**: Write 1-2 sentences summarizing what the student will learn or accomplish. Focus on the main skills or concepts.
21+
- **Tasks**: For each task:
22+
- Use a specific, action-oriented task name
23+
- In the Description, clearly state what the student must do.
24+
- In Requirements, use bullet points to list the expected outcomes or features. Be specific and measurable
25+
- Provide example input/output in code blocks if helpful.
26+
27+
Do not include extra sections unless explicitly specified.
Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,21 @@
1+
# 📘 Assignment: Games in Python
12

2-
# 🎮 Hangman Game Challenge
3+
## 🎯 Objective
34

4-
Build the classic word-guessing game using Python strings, loops, and user input.
5+
Build a classic Hangman word-guessing game using Python to practice string manipulation, loops, conditionals, and user input handling.
56

6-
## � What You'll Build
7+
## 📝 Tasks
78

8-
Create a Hangman game where players guess letters to reveal a hidden word before running out of attempts.
9+
### 🛠️ Create the Hangman Game
910

10-
**Skills practiced:** String manipulation, loops, conditionals, random selection
11+
#### Description
12+
Create a Hangman game where players guess letters to reveal a hidden word before running out of attempts.
1113

12-
## ✅ Must Have's
14+
#### Requirements
15+
Completed program should:
1316

14-
Your game must:
1517
- Randomly select words from a predefined list
1618
- Accept letter guesses and show current progress (_ _ _ format)
1719
- Track incorrect guesses remaining
1820
- End when word is guessed or attempts exhausted
19-
- Display win/lose messages
21+
- Display win/lose messages

0 commit comments

Comments
 (0)