This workshop is setup to give an overview of Git and a hands-on exercises on a GitHub practice GitHub repository. At the end of the workshop you should be able to:
- identify Git, GitHub, and the differences between Git and GitHub
- describe how Git works
- follow, favorite, and fork a repository in Github
- commit to, push to, pull to, clone, download, and open a repository
- add and close an issue in GitHub
- start a pull request and approve a pull request
- add a GitHub action and a GitHb package
- set up a GitHub Project and a GitHub Wiki
- add security options to a repository
- understand the insights and setting for a repository
- customize their GitHub profile page
- create a professional level README.md for a repository
- Click on the 'Watch' dropdown menu
- Select your preferred notification level
- Not watching
- Releases only
- Watching
- Ignoring
- You can star repositories and topics to keep track of projects you find interesting and discover related content in your news feed
- You can search, sort, and filter your starred repositories and topics on your stars page
- Click on your 'Avatar' dropdown menu and select 'Your Stars'
- Starring makes it easy to find a repository or topic again later
- You can see all the repositories and topics you have starred by going to your stars page
- You can star repositories and topics to discover similar projects on GitHub
- When you star repositories or topics, GitHub may recommend related content in the discovery view of your news feed
- For more information, see "Finding ways to contribute to open source on GitHub"
- Starring a repository also shows appreciation to the repository maintainer for their work
- Many of GitHub's repository rankings depend on the number of stars a repository has
- In addition, Explore shows popular repositories based on the number of stars they have
- Click on the 'Fork' button
- Select where you want to Fork the Repository to
- Wait for it to reproduce in that Organization
- Click on the 'Create new file' button
- Name and give your new file a valid extension
- Add content to the file
- Give a title to the commit
- Click on the 'New pull request' button
- Review the changes you made to the Main Project
- Click on the 'Create pull request' button
- Add a description of the changes you made so that the repository owner understands what you are trying to do and why they should approve your request
- Click on the 'Code' tab to open the dialog (this is also the default view)
- Click on the 'commits' link
- Each row depicted is an individual commit within your respository
- Click on the 'Verified' button to view the GitHub key used to sign the commit
- Click on the 'Clipboard' button to copy the SHA-1 Hash of that particular commit
- Click on the 'Hashed' button to open the dialog to view the changes within that commit
- Click on the '<>' button to revert your repository back to that commit
- Click on the 'Issues' tab to open the dialog
- Click on the 'New issues' button
- Give the issues a title and description
- Click on the 'Submit new issue' button
- Click on the 'Issues' tab to open the dialog
- Click on the appropriate issue to open it
- Assign the issue to a member of the team
- Click on the 'Assignees' gear
- Begin entering their GitHub user name
- Assign the name to the issue
- Assign a label to the issue
- Click on the 'Labels' gear
- Begin entering the name of the label
- Assign the label to the issue
- Assign a Project to the issue
- Click on the 'Projects' gear
- Begin entering the name of the project or select where the project resides by the sub tabs
- Select the appropriate Project
- Assign a Milestone to the issue
- Click on the 'Milestones' gear
- Begin entering the name of the milestone
- Assign the milestone to the issue
- Assign a Linked pull request to the issue
- Click on the 'Linked pull request' gear
- Begin entering the name of the pull request to link to the issue
- Assign the Linked pull request to the issue
- Unsubcribe to the issue
- Click on the 'Unsubscribe' button
- Owner is notified under the 'Pull requests' tab
- Click on the 'Pull requests' tab to open the dialog
- Review the changes that are being proposed to your Project
- Click on the 'Merge pull request' button to approve the changes
- Click on the 'Confirm merge' button to confirm the merging of the two Projects
- Add a description of the changes you made so that the repository owner understands what you are trying to do and why they should approve your request
- Click on the 'Actions' tab to open the dialog
- Review the prebuilt Actions to determine if they suit your needs
- After finding your preferred workflow, click on the 'Set up this workflow' button
- Review the .yml code to ensure it is correct and you do not have to add file names, keys, etc to run the action
- Click on the 'Start Commit' button
- Add a commit message to the commit
- Select which branch to commit the action
- Click on 'Commit new file' button More on GitHub Actions
- Click on the 'Projects' tab to open the dialog
- Click on the 'Create a project' button
- Give your project a title and a description
- Click on the 'Template: None' dropdown menu
- 'None' creates a blank board
- 'Basic kanban' creates an empty 3-column board (To do, In progress, Done)
- 'Automated kanban' creates the Basic board but with triggers to move issues and pull requests within the project board
- Click on the 'Create project' button
- Click on the '+' on top of one of the columns
- Add a title/ short description to the note
- Click 'Add' button
- Edit the card by clicking on the 'Elipsis'
- Convert card to an issue
- Edit card
- Click on the 'Wiki' tab to open the dialog
- Click on the 'Create the first page' button
- Add content and style the homepage of your new wiki
- Add additional information
- Click on the 'New Page' button
- Add content and style to the new page
- Add a custom footer and/ or sidebar
- Video Walkthrough
- Click on the 'Security' tab to open the dialog
- Click on 'Set up a security policy' button
- Click on 'Start setup' button
- Modify the SECURITY.md file
- Click on 'View security advisories' link
- Click on 'New draft security advisory' button
- Fill out the form
- Click on the 'Create security advisory' button
- Click on 'Enable dependency alerts' button
- Opens into the 'Settings' dialog
- Toggle 'Security alerts' turn on and off alerts on new found vulnerabilities within your repository
quick change
- Click on the 'Insights' tab to open the dialog
- Explore the left sidebar for all of the different insights that GitHub has collected on your repository
- README.md Template
- https://github.com/matiassingers/awesome-readme
- https://guides.github.com/features/mastering-markdown/
- https://shields.io/
- https://www.freecodecamp.org/news/what-i-learned-from-an-old-github-project-that-won-3-000-stars-in-a-week-628349a5ee14/
Copyright 2020 TAMUSA-ACM
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.