publishing_to_github.md

Publishing This Repo To GitHub

This repo is prepared as a local GitHub-ready teaching repository. To share it with students, publish it to GitHub.

Recommended Repo Settings

Suggested repository name:

ml_intro_practice

Suggested visibility:

• Private if the materials are still being revised.
• Public if you want students outside your group to reuse them.

Before Publishing

Check:

• no student names are included;
• no private research data are included;
• generated files such as data/toy_tb_migration.csv are ignored by Git;
• the README explains where students should start.

Command-Line Publishing

From the parent folder:

cd ml_intro_practice
git status

If this is a new local repo:

git init
git add .
git commit -m "Create ML intro practice materials"

Then create an empty GitHub repo online named ml_intro_practice.

Connect the local repo to GitHub:

git remote add origin https://github.com/YOUR_USERNAME/ml_intro_practice.git
git branch -M main
git push -u origin main

Replace YOUR_USERNAME with the correct GitHub username or organization.

GitHub Desktop Option

If using GitHub Desktop:

1. Choose File -> Add Local Repository.
2. Select the ml_intro_practice folder.
3. Publish the repository.
4. Choose private or public visibility.

Note About Licenses

Before making the repo public, choose a license. If you want students and other mentors to freely reuse the materials, common options are:

• MIT License for code-focused repos;
• Creative Commons Attribution 4.0 for teaching materials;
• Creative Commons Attribution-NonCommercial 4.0 if you do not want commercial reuse.

If no license is added, others technically do not have permission to reuse the materials beyond normal viewing.