search

liliive / orpheus-s-science-project

Dino + Science = Dino-mite
https://lab.github.com/P2PHackClub/p2p-hack-club's-introduction-to-github
MIT License
0 stars 0 forks source link

Getting Started with GitHub #1

Open github-learning-lab[bot] opened 3 years ago

github-learning-lab[bot] commented 3 years ago

:wave: Heyyyyyy! Welcome to the party on GitHub :confetti_ball:

This is P2P Hack Club's Introduction to GitHub

Written by JP and Reema, this hopefully should be working by the time the meeting has started. Let us know if there are any issues you come across! :smile:

Joyful_Orpheus

Orpheus: Hey! So..... I have a problem. I am making a website for my science project, and... tbh I need a **lot** of help. I'm hosting the code on GitHub, can you get it working?

Mission Start!

dino_and_octocat_becoming_friends

To help Orpheus with their science project, you're going to need some knowledge of the hosting platform that they're using, GitHub.

TEACHER ORPHEUS!!!! HELP!!!!!!! D: :sos:

:point_down: This arrow means you can expand the window! Click on them throughout the course to find more information.

Soooo.... what is GitHub? ## Soo... what is GitHub? I'm glad you asked! Many people come to GitHub because they want to contribute to open source [:book:](https://help.github.com/articles/github-glossary/#open-source) projects, or they're invited by teammates or classmates who use it for their projects. Why do people use GitHub for these projects? GitHub is a code-hosting platform for collaboration. GitHub is a place where anyone can contribute to develop their favorite software, file bug reports, and create their own projects! It simplifies the process of collaborating with other people, and makes it easy to collaborate on projects. All of these projects are **open-source**, which is a type of computer software in which source code is avaliable to view freely online. Some of your favorite pieces of software, like Firefox, Android, Chrome (based on Chromium), and more are built with open source. If you want to see the source code of your browser, or your phone, you can find it easily online, and even contribute to it! *You can actually sync your repl.it projects (remember your Discord bots?) to GitHub, and allow anyone to edit and view the source! You could even ask other people to write features for you, or take bug reports!* **So, version control??** GitHub uses Git [:book:](https://help.github.com/articles/github-glossary/#git), the most popular open source version control software, to track every contribution and contributor [:book:](https://help.github.com/articles/github-glossary/#contributor) to your project--so you know exactly where every line of code came from. Think of version control like Google Doc's history tab. It's a log of every change to your code. **NASA FTW!!!!** GitHub is used to build some of the most advanced technologies in the world. Whether you're visualizing data or building a new game, there's a whole community and set of tools on GitHub that can get you to the next step. This course starts with the basics, but we'll dig into the rest later! :tv: [Video: What is GitHub?](https://www.youtube.com/watch?v=w3jLJU7DT5E)

Exploring a GitHub repository
## Exploring a GitHub repository :tv: [Video: Exploring a repository](https://www.youtube.com/watch?v=R8OAwrcMlRw) ### More features The video covered some of the most commonly-used features. Here are a few other items you can find in GitHub repositories: - Project boards: Create Kanban-style task tracking board within GitHub - Wiki: Create and store relevant project documentation - Insights: View a drop-down menu that contains links to analytics tools for your repository including: - Pulse: Find information about the work that has been completed and the work that’s in-progress in this project dashboard - Graphs: Graphs provide a more granular view of the repository activity including who contributed to the repository, who forked it, and when they completed the work ### Special Files In the video you learned about a special file called the `README.md`. Here are a few other special files you can add to your repositories: - CONTRIBUTING.md: The `CONTRIBUTING.md` is used to describe the process for contributing to the repository. A link to the `CONTRIBUTING.md` file is shown anytime someone creates a new issue or pull request. - ISSUE_TEMPLATE.md: The `ISSUE_TEMPLATE.md` is another file you can use to pre-populate the body of an issue. For example, if you always need the same types of information for bug reports, include it in the issue template, and every new issue will be opened with your recommended starter text. ---
### Using issues This is an issue [:book:](https://help.github.com/articles/github-glossary/#issue): a place where you can have conversations about bugs in your code, code review, and just about anything else. Issue titles are like email subject lines. They tell your collaborators what the issue is about at a glance. For example, the title of this issue is Getting Started with GitHub.
Using GitHub Issues ## Using GitHub issues Issues are used to discuss ideas, enhancements, tasks, and bugs. They make collaboration easier by: - Providing everyone (even future team members) with the complete story in one place - Allowing you to cross-link to other issues and pull requests [:book:](https://help.github.com/articles/github-glossary/#pull-request) - Creating a single, comprehensive record of how and why you made certain decisions - Allowing you to easily pull the right people and teams into a conversation with @-mentions :tv: [Video: Using issues](https://www.youtube.com/watch?v=Zhj46r5D0nQ) ---
Managing notifications
## Managing notifications :tv: [Video: Watching, notifications, stars, and explore](https://www.youtube.com/watch?v=ocQldxF7fMY) Once you've commented on an issue or pull request, you'll start receiving email notifications when there's activity in the thread. ### How to silence or unmute specific conversations 1. Go to the issue or pull request 2. Under _"Notifications"_, click the **Unsubscribe** button on the right to silence notifications or **Subscribe** to unmute them You'll see a short description that explains your current notification status. ### How to customize notifications in Settings 1. Click your profile icon 2. Click **Settings** 3. Click **Notifications** from the menu on the left and [adjust your notification preferences](https://help.github.com/articles/managing-notification-delivery-methods/) ### Repository notification options * **Watch**: You'll receive a notification when a new issue, pull request or comment is posted, and when an issue is closed or a pull request is merged * **Not watching**: You'll no longer receive notifications unless you're @-mentioned * **Ignore**: You'll no longer receive any notifications from the repository ### How to review notifications for the repositories you're watching 1. Click your profile icon 2. Click **Settings** 3. Click **Notification** from the menu on the left 4. Click on the [things you’re watching](https://github.com/watching) link 5. Select the **Watching** tab 6. Click the **Unwatch** button to disable notifications, or **Watch** to enable them
### Keep reading below to find your first task Now that you've gotten some of the basics down, it's time to use what you learned about GitHub to help Orpheus!
github-learning-lab[bot] commented 3 years ago

Step 1: Assign yourself

Joyful Orpheus

It's time to own your issues. Wait, that's not what I mean.

Unassigned issues don't have owners to look after them. When you’re assigned to an issue or pull request, it tells repository visitors and contributors that you'll be facilitating the conversation or task :muscle:.

:keyboard: Activity

  1. On the right side of the screen, under the "Assignees" section, click the gear icon and select yourself

I'll respond when I detect you've assigned yourself to this issue.

Sometimes I respond too fast for the page to update! If you perform an expected action and don't see a response from me, wait a few seconds and refresh the page for your next steps.

github-learning-lab[bot] commented 3 years ago

Step 2: Turn on GitHub Pages

:tada: You're now the proud manager of this issue! Now that you've assigned yourself, people who drop by know that they're welcome to participate, but you'll be carrying this issue across the finish line. :sunglasses:.

Joyful_Orpheus

Orpheus: Right, so I see that you assignned yourself to the project :smile:. Thank you sooooooo much! So, I'm have some code in my repository for a website, but I don't know how to get it from GitHub to publish onto the web! Can you help me?

Let's use GitHub Pages

Now, on to business! GitHub Pages allow you to serve a static site from a repository. We've filled this repository with some site content, but the rendered site isn't visible right now. Let's change that.

:keyboard: Activity: Enable GitHub Pages

  1. Click on the Settings tab in this repository
  2. Scroll down to the "GitHub Pages" section
  3. From the "Source" drop down, select main branch

Note: Even though you'll see an option to choose a theme, do not apply a theme at this point. We've protected the code so you can't make unintended changes.

I'll respond in this issue when I detect GitHub Pages has deployed your site.

Turning on GitHub Pages creates a deployment of your repository. I may take up to a minute to respond as I await the deployment.