Writing Good Commits & Recipe Project

📝 Part 1: Writing Good Commits

Why Commit Messages Matter

List three reasons why good commit messages are important:

1. _________________________________________
2. _________________________________________
3. _________________________________________

Anatomy of a Good Commit Message

A good commit message has two parts:

1. Subject Line: Describes _________________ you did
   Character limit: _____ to _____ characters
2. Body (optional): Explains _________________ you did it and _________________ it solves the problem

Bad vs. Good Commits

The 7 Rules of Great Commit Messages

1. Separate subject from body with a _________________
2. Limit subject line to _____ characters
3. _________________ the subject line
4. Don't end subject line with a _________________
5. Use _________________ mood (e.g., "Add" not "Added")
6. Wrap body at _____ characters
7. Use body to explain _________________ and _________________, not how

When to Commit

You should commit when you (check all that apply):

• ☐ Complete a feature (even a small one)
• ☐ Fix a bug
• ☐ Add a new file or component
• ☐ Make a meaningful change that works
• ☐ Before trying something experimental
• ☐ End of a work session (with working code)

Creating Multi-line Commits

To create a commit with subject and body:

✍️ Practice: Fix These Commits

Rewrite these bad commit messages to be more descriptive:

Bad Commit	Your Improved Version
"css changes"	_________________________________________
"oops"	_________________________________________
"FINALLY!!!!"	_________________________________________
"stuff"	_________________________________________

🍳 Part 2: Recipe Project Requirements

Project Structure

Your project needs:

• Main _________________ page listing all recipes
• At least _____ separate recipe pages
• Proper file organization (folders for _________________ and _________________)
• Links between _________________ pages

Each Recipe Page Must Include

Check off as you complete each requirement:

• ☐ Recipe title using _____ tag
• ☐ Image of the dish with proper _____ attribute
• ☐ Description in a _____ tag
• ☐ Ingredients using _____ list (unordered)
• ☐ Steps using _____ list (ordered)
• ☐ Link back to _________________

File Structure

Draw or write your project's file structure:

HTML Template - Index Page

Fill in the missing parts:

HTML Template - Recipe Page

Complete the image tag with proper attributes:

Write the link tag to go back to the main page:

🔄 Git Workflow for Your Project

Suggested Commit Messages

Write appropriate commit messages for these milestones:

1. Creating initial project structure:
   _________________________________________
2. Adding the main index page:
   _________________________________________
3. Adding your first recipe:
   _________________________________________
4. Adding images to recipes:
   _________________________________________
5. Fixing a broken link:
   _________________________________________

Git Commands Sequence

Number these commands in the correct order (1-5):

• ___ git push origin main
• ___ git add .
• ___ Make changes to files
• ___ git commit
• ___ git status (to check what changed)

🔧 Common Issues & Solutions

Problem	Possible Cause	Solution
Images not showing	_________________ path is wrong	Check ../ for going up directories
Links not working	Missing _________________ extension	Include .html in href
Page looks weird	Missing closing _________________	Check all tags are closed properly

✅ Final Submission Checklist

Before submitting on D2L, ensure you have:

• ☐ Main index page with links to all recipes
• ☐ At least 3 recipe pages
• ☐ Each recipe has all required elements
• ☐ All links work correctly
• ☐ All images display properly
• ☐ Proper HTML structure (DOCTYPE, head, body)
• ☐ Meaningful commit history
• ☐ Pushed to GitHub
• ☐ GitHub repository link ready to submit

📝 Additional Notes

Use this space for any additional notes, questions, or reminders:

🎯 Key Takeaways

The three most important things I learned today:

1. _________________________________________
2. _________________________________________
3. _________________________________________

One thing I want to practice more:

_________________________________________