Lesson 2 - Contributing your First PR! - Githubissues

gt-ospo / oss-training

Topical training for getting started with open-source development

Creative Commons Attribution Share Alike 4.0 International

2 stars 3 forks source link

Lesson 2 - Contributing your First PR! #1

Open jyoung3131 opened 1 month ago

jyoung3131 commented 1 month ago

This lesson will teach the following skills:

How to work through an example codebase with an issue tracker.
Understanding the Pull Request process.
Contributing a meaningful PR.

jyoung3131 commented 1 month ago

Forks

Why is forking useful?
How do you manage your fork?
Using multiple remotes (origin, upstream, etc)
Keeping fork up-to-date with upstream (fetching and merging from different remote tracking branches)
Mention that some projects (esp. smaller teams and private repos) might keep all topic branches on the main repo (without forks)

Refs: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks

Pull requests

How big should a PR be (lines of code, scope, …)
What should you write in the PR description?
How are PRs reviewed? Refs: https://opensource.com/article/18/6/anatomy-perfect-pull-request https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/getting-started/best-practices-for-pull-requests https://github.blog/2015-01-21-how-to-write-the-perfect-pull-request/

Issues

Using issues for feature requests, bug reports
Issues as a good starting point for OSS contributions
Integration with Pull Requests (how to link an issue to a PR, how to auto-close an Issue when a PR is accepted)
Using issues for project management Refs: https://docs.github.com/en/issues/tracking-your-work-with-issues