Activity for practicing with git and issues on GitHub.
For this activity, the students will practice making changes to a GitHub repository. The repository has a text file that has been "twiddled" - meaning that random words have had their characters randomly rearranged, and considered to be issues to be fixed.
The students will:
- Fork the repository
- Clone the repository
- Add the original repository as an upstream remote
- Create a
fix-license-typosbranch, and switch to that branch - Repeat as often as possible during the class:
- Assign themselves to an issue (e.g. issue #42)
- Edit the LICENSE file to correct the issue
- Add the change
- Pull any changes that have ocurred since their last pull, and correct merge conflicts
- Commit the change, with a message describing the change (include line number and correction, e.g.
Correct misspelling, line 1: UGN -> GNU) - Push the change
- Make a pull request to have their change merged into the original repository, including in the pull request text a notation that it closes the assigned issue (e.g.
Closes #42)
The misspellings were generated by the twiddle.py program from git-twiddler, and then entered as issues by the report.py program (from this git-twiddler fork currently waiting for this pull request to be merged.)