How to Correctly Open a Pull Request (PR)

This guide explains why and how students must link Issues to their Pull Requests, and how to get instructor review efficiently.

⸻

Why This Matters • Issue linkage: Writing Closes #<ISSUE_NUMBER> in your PR description automatically connects the PR to the Issue. When the PR is merged, the Issue will close. • Instructor notification: Adding @cynthiateeters ensures your instructor sees the PR promptly. • Validation: Running the local validator before pushing helps avoid failed checks.

⸻

Example PR (based on Issue #64)

Title: Add article on CSS currentColor keyword (Closes #64)

Description (Markdown):

Summary

This PR adds a new card about the CSS currentColor keyword.
It explains how currentColor allows elements to inherit the text color dynamically and provides a simple example.

Linked Issue

Closes #64

Details

• Added cards/2025-09-25-css-current-color.md
• Front matter includes a descriptive title and tags
• Content explains the use case and provides sample HTML/CSS code

Checklist

• Validated card locally with npm run validate:cards
• Linked to the Issue using Closes #64
• Mentioned instructor for review: @cynthiateeters

⸻

Reusable PR Template

Place this file in your repo at .github/pull_request_template.md:

Summary

[Provide a short description of the change.]

Linked Issue

Closes #<ISSUE_NUMBER>

Details

• [Describe what files were added/changed.]

Checklist

• Validated card locally with npm run validate:cards
• Linked to the Issue using Closes #<ISSUE_NUMBER>
• Mentioned instructor for review: @cynthiateeters

⸻

Student Checklist

1.	Comment on the Issue: “I’ll take this one.”
2.	Open a PR: Title + Closes #ISSUE_NUMBER
3.	Mention instructor: @cynthiateeters
4.	Validate locally: Run npm run validate:cards before pushing

⸻