This repository is here to help you with the concept of pull requests. Pull requests are the most common way to contribute to open source projects these days.
This might be your very first Pull Request Club assignment. We hope you find this helpful and exciting!
Your assignment is submitting a Pull Request to this very repository. We recommend adding your name (and a comment if you like) to CONTRIBUTORS.md and submitting just that. Make sure you are logged in to your GitHub account. Here's how to proceed:
You need to "fork" (make a copy of) this repository. See, this repository is called kyzn/welcome-to-prc, where kyzn is my username. Unless you have right permissions, you won't be able to make any changes to it. There is a useful "Fork" button at top right of this page.
You should click that button to get your own copy. If you are in a GitHub organization, you may see a prompt that looks like below.
If you see that, we recommend you choose your own name (the one at top).
Now you have your own copy, in your own namespace. You can modify it as you like.
Now find the file CONTRIBUTORS.md.
If you click on the filename, GitHub will show you the file. There, find the "pencil" which means "edit".
Clicking that will show you the file editor.
Add your name and any comments you have to the end of file.
On the same page, scroll to the bottom. Find this commit panel.
While "Commit directly to the main branch" is selected, click "Commit changes".
Go back to the home page of your forked repository. There, you should see a note that says your branch is 1 commit ahead.
That note comes with a "Pull request" button on the right. Click that.
Click "Create pull request" to reveal a message editor.
Feel free to leave a pull request comment. Then click "Create pull request".
Above is how your "open" pull request will look like. At this point, you can go back to Pull Request Club and mark your assignment as done. Great job!
Your pull request will look like this once it's merged. At this point you can delete your forked repository.
You did great!
If you would like to improve this documentation, you are most welcome! Just submit some more pull requests.
- https://www.youtube.com/watch?v=Ip5x-UtOM6k
- https://github.com/CPAN-PRC/resources/wiki/My-first-Pull-Request
- https://pullrequest.club/help
- https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests
Kivanc Yazan
MIT