The personal milestones table outlines key milestones for practical programming skills development tailored to chemistry students. By incrementally working through activities like creating a GitHub account, making commits, branches, pull requests, and reviewing others' submissions, students can gain first-hand experience with version control, collaboration, and real-world software development workflows. The table provides placeholder links for students to fill in with the specific URLs corresponding to their completion of each task.
Link: They should insert the actual URL where they achieved each milestone into the Link column. For example, they would link directly to their updated profile, the forked repository, the specific commit, the pull request they made, or the pull request they reviewed. ❗ Replace the placeholders (including ') with the actual URLs ❗ - only the marked sections will change.
| Week | Milestone | Link |
|---|---|---|
| 1 | Github Account Created | https://github.com/`username` |
| 1 | Github Profile Page | https://github.com/`username`/`username` |
| 1 | Commit and Push Change from Command Line | https://github.com/`username`/`repo-name`/commit/`commit-nr` |
| 1 | Create a New Branch | https://github.com/`username`/`repo-name`/tree/`new-branch-name` |
| 1 | Create a conda environment | https://github.com/`username`/`repo-name`/blob/`branch-name`/`env.yml` |
| 1 | Fork a Repo | https://github.com/`username`/practical-programming-in-chemistry-milestones |
| 1 | (Optional) Make a Pull Request | |
| 2 | (Optional) Review a Pull Request | |
| 4 | Update env.yml via a Pull Request |
https://github.com/`username`/practical-programming-in-chemistry-milestones/pull/`pull-request-number` |
More milestones will be added throughout the course.
Each student should start by forking this repository that contains the milestones list. This is done on GitHub by navigating to the repository's page and clicking the "Fork" button. This creates a copy of the repository in the student's own GitHub account.
Next, the student clones their forked repository to their local machine, creating a local working copy. This is done using the Git command line interface (CLI) with the following command :
git clone https://github.com/<username>/practical-programming-in-chemistry-milestones.gitReplace username with your GitHub username.
In order to show that you succesfully accomplished the milestones, please edit the table above by replacing the placeholder links with valid links. These should point us to the specific place on your GitHub. The easiest way to edit this README file by in-browser editing, like so:
How to find a commit link
- Go to your repository on GitHub.
- Navigate to the commit message that you used to push your image of the molecule. This is an example of a commit online:
- By clicking on this commit message you open a detailed view of this commit. Copy the link to that page.
After cloning the forked repository, the student should navigate into the repository's directory using the command line and set up the original repository as an upstream remote. This links the local copy to the original repository, allowing the student to pull updates.
cd practical-programming-in-chemistry-milestones
git remote add upstream https://github.com/schwallergroup/practical-programming-in-chemistry-milestones.gitWhenever the instructor updates the upstream repository (e.g., adding new milestones or resources), students can synchronize their local and forked copies with those updates. To do this, they first pull the changes from the upstream repository to their local repository:
git fetch upstream
git merge upstream/main main
Here, main is the branch name of your repo, upstream refers to the repo on the schwallergroup, and upstream/main to its main branch.
After merging the updates from the upstream repository into their local repository, students may need to push these updates to their forked repository on GitHub:
git push origin mainorigin refers to your forked repository. So, you will push the changes to your own main branch.