4 Contribute to an Open Source Project on GitHub

mebaumb редактировал(а) эту страницу 2021-04-23 08:01:05 -07:00

Содержание

• Event Information
• Content
• Instructor notes

Event Information

Category	Details
Reactor Topic	DevOps and Dev Tools
Workshop Level	Beginner
Workshop Duration	60 mins
Title	Use GitHub to Contribute to an Open-Source Project
Description	GitHub is the largest open source community in the world, with millions of open-source projects. One of GitHub's strengths is how easy it is to collaborate on projects. In this workshop, we'll walk through how easy it is to find and contribute to open-source projects on GitHub. We'll show you how to create pull requests, communicate with the project maintainers to effectively to get your changes accepted and will deep dive into the benefits of getting involved with open-source communities. This is a beginner's level workshop, but you should join this workshop with a GitHub account set up and a basic knowledge of how to navigate and edit files in GitHub.

Content

https://aka.ms/GHOSProject-8

Workshop Run Dates: April 20 & 21, 2021 - All Locations

Instructor notes

Share this link with attendees at the beginning of the workshop: https://aka.ms/GHOSProject-8

Let them know this is the content that will be covered, and that following the workshops they should step through to complete the module, including answering the knowledge check questions and rating the module.

This workshop covers using how to contribute to an open-source project.

Workshop steps:

1. Start with an overview about GitHub being the home for open source projects. Explain the benefits of contributing to and/or maintaining open-source software.

2. Identify how to find an open source project that needs contributions. Here are some helpful links you might share:

   • https://github.com/search and search by topic. see if projects have issues that need help
   • https://docs.github.com/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github
   • https://github.com/MunGell/awesome-for-beginners
   • https://github.com/showcases/great-for-new-contributors
   • https://goodfirstissue.dev/
   • https://github.com/topics/good-first-issue

3. Explore a repository. Pick a repository and have a look through their README, contributing docs and code of conduct. Check out which open source license the project has. Then look at the issues that are open for contribution. Explain how you can find an issue to work on that's good for your skillset.

4. Walk through how you would submit a Pull Request to an open source project. You can pick an existing project of your choosing, or create a new repository of your own with an issue to fix.

   • Pick an issue and assign yourself to it (first make sure no one else has assigned themselves before you).
   • Fork the repository
   • Start on a fix to the issue
   • Create the pull request
   • Make sure statuses pass
   • Make sure to tag the appropriate people/teams as reviewers
   • Watch for comments and changes on your pull request

5. Explain GitHub Sponsors and how that works for project maintainers.

Wrapping up:

• At the end of the workshop, remind attendees to complete the knowledge check and summary so they can get a badge for completing the module.
• Also please encourage them to rate the module 😄
• Share out the survey link: https://aka.ms/Reactor/Survey with the event code (the Reactor contact on the call can give you this)