Skip to content

🔴 Workflow E: Finalize Project

Finalize your project for your GitHub portfolio.

WHY?

Showcase your work.

A GitHub repository is often the first thing a reviewer, teammate, or future employer sees. The README, documentation, About section, and commit history together show what the project does, the decisions behind it, and how professionally it was built.

Results that are hard to find or understand are easy to overlook, so these finishing touches are an important part of the work.

Finishing Touches

Present your independent work professionally.

  1. Update Project Documentation
  2. Update Project README
  3. Update GitHub About Section

After each area is finalized, do the usual using the commands provided in the README.md:

  1. Manage the Environment
  2. Setup and Run Git Hooks
  3. Run the Project
  4. Do Chores
  5. ⭐Git Add-Commit-Push to GitHub

Verification: README

The README.md is the project landing page.

  • [ ] Includes name or alias, and year and month.
  • [ ] Project Overview states what the project does and which problem was chosen.
  • [ ] Project Commands allow a new analyst to set up and run the project using only the README.
  • [ ] Includes at least one visual with evidence confirming the work.
  • [ ] Common links at the end include the docs, the example adapted, and the data source.

Verification: docs/index.md

The data story is told in docs/index.md.

  • [ ] Follows the project instructions for sections (if provided), with each section containing content.
  • [ ] Includes at least one visual that displays on the published docs page.
  • [ ] Links in README.md and docs/index.md resolve.
Telling a Data Story via docs/index.md

The ability to communicate your work professionally is arguably as important as your ability to distill useful insights. If project-specific sections are not specified, something like this might work, but it will vary by project.

  • Opening: title, name or alias, year and month, summary
  • Data
  • Techniques Applied
  • Custom Modifications
  • Methods and Settings
  • Verification
  • Results
  • Observations
  • Interpretation and Insights
  • Limitations
  • Next Steps

Success

This workflow is complete when your GitHub Repository:

  • [ ] Actions tab shows all current Actions passing (green), and the docs are published.
  • [ ] About section has a clear description, a clickable link to the docs, and keywords.
  • [ ] Commit history includes one or more commits for each progression.
  • [ ] Commit messages say what changed and why, and would help a teammate.
  • [ ] Has no environment folders (.venv), caches, or other generated files are tracked.
  • [ ] Has no secrets, private data, or oversized data files are committed.
  • [ ] Has no unintended references to the example.
  • [ ] Formatting and presentation are clear and consistent.

◄ Back to 🏠 Guide Home