.github

About the .github Folder

The .github/ folder contains files GitHub uses to support this repository. These files configure repository administration, automated checks, issue forms, and supporting assets. They are not assignment deliverables.

Important

Students: Do not modify or delete files in .github/ unless the course instructions specifically tell you to do so.

What This Folder Contains

Path	Purpose
ISSUE_TEMPLATE/	Defines the GitHub Issue forms used to report repository problems and request improvements.
assets/	Stores screenshots and other images used by repository documentation.
ci/	Stores CI documentation and Python support scripts used by GitHub Actions.
workflows/	Stores GitHub Actions workflow definitions.
social-preview.png	Provides the repository social-preview image shown when the repository is shared.

Subfolders

ISSUE_TEMPLATE/

This folder contains the public forms used from the repository's Issues tab:

• report-a-problem.yml — report a technical or documentation problem.
• request-an-improvement.yml — suggest an improvement to the repository or its instructions.

assets/

This folder contains screenshots and other documentation images referenced by the assignment README files.

ci/

This folder contains the supporting files for continuous integration (CI):

• README.md — explains GitHub CI for students, faculty, and maintainers, including the cross-platform README command checks.
• check_repository.py — validates the course repository structure and provided assignment artifacts.
• check_starter.py — verifies that the intentionally incomplete assignment starter remains in its expected state.
• check_readme_commands.py — validates README shell command blocks and smoke-tests selected command sequences across supported shells.

See the GitHub Continuous Integration Guide for details about what these checks do and how to interpret them.

workflows/

This folder contains the GitHub Actions workflow definitions:

• tests.yml — runs the main course-repository checks and the student-facing Python program check.
• readme-commands.yml — checks README shell commands on Linux/Bash, macOS/zsh, and Windows/Git Bash.
• external-links.yml — checks external links used by the course repository.

The workflow files call the supporting scripts in ci/.

For Maintainers

Changes to .github/ can affect every student repository created from this course template. Before merging changes:

1. Review the affected workflow or support file carefully.
2. Confirm the applicable GitHub Actions checks pass.
3. Keep workflow permissions limited to what the workflow needs.
4. Update the GitHub Continuous Integration Guide when CI behavior changes.

For repository-wide student instructions, use the Module Two Assignment README rather than adding student procedures to this administrative folder.