I opened my first pull request on GitHub in October 2017, during the first Hacktoberfest I attended. I had a few years of experience using git, but working on open-source is different. As I have gone through the process once, I can guide you through your first pull request.
Step 0: Sign Up for Hacktoberfest
First, you need to sign up for Hacktoberfest. Go to hacktoberfest.com and sign up with your GitHub account. Well, you also need a GitHub account if you don't have one.
Step 1: Find an Issue
As a first-time contributor, you may want to start with a simple issue. You can find issues labeled good first issue or beginner-friendly in many repositories. I have created one that you can work on:
Add your name to the SUPPORTERS.md
#33
This would be an easy task for people who want to get started with contributing to open-source. This is how it's done:
- From the toolbar in the top right of your screen, click Fork. This will create a fork of the project.
- In your own fork, click on
SUPPORTERS.md, and from the buttons in the top right of the file preview, click on the pencil button. - Add your name and GitHub profile to the end of the list as follows:
- In a new line, write down:
- [Name Surename](https://github.com/<your-handle>) - At the bottom of the page, select "Create a new branch for this commit and start a pull request." and click "Commit Changes".
- In a new line, write down:
- Finalize creating the merge request.
This is an easy issue, only requiring you to add one line of text to the file SUPPORTERS.md. So, let's get started.
Step 2: Fork the Repository
To work on the issue, you need to fork the repository:
RxJS Extensions
RxJS operators to deal with arrays, tuples, and dragging the original values along while adding more values to the pipeline.
🛠️ Install
npm install --save @rxjsx/rxjsx rxjs
🧑💻 Demo
import { of } from 'rxjs';
import { flatListMap } from '@rxjsx/rxjsx';
of([1, 2, 3], [4], [5, 6])
.pipe(flatListMap(x => of(x, 10+x)))
.subscribe(console.log);
You can experiment with the above code by forking this ReplIt repo or through this Medium article.
📖 Examples
// instead of this
of([1, 2, 3]).pipe(map(l => l.map(e => e * 2))
// you can do this
of([…Click on the Fork button on the top right corner of the page. This will create a copy of the repository in your GitHub account. The URL of the repository will change to github.com/your-username/rxjsx.
Step 3: Change the File Online
Now, you can change the file online. Go to the file SUPPORTERS.md in your forked repository and click on the pencil icon on the top right corner of the file. This will allow you to edit the file.
The file is written in Markdown, so you can add your name to the list of supporters like this:
- [Mohammad-Ali A'râbi](https://github.com/aerabi)
You need to replace Mohammad-Ali A'râbi with your name and the URL with your GitHub profile URL.
Step 4: Create a Pull Request
After you have made the change, scroll down to the bottom of the page. You will see a section called Propose changes. Here, you can write a title and description for your pull request. Be sure to write a meaningful title and description, so the maintainer knows what you have done. In this case, you can write something like Add my name to SUPPORTERS.md.
After you have written the title and description, click on the Propose changes button. This will create a pull request in the original repository.
Step 5: Wait for Review
Now, you need to wait for the maintainer to review your pull request. They may ask you to make some changes or approve it directly. If they ask you to make changes, you can go back to the file and edit it again. In this case, I'm the maintainer of the repository, and the change is simple, so most likely I will approve it directly.
Step 6: Celebrate
Congratulations! You have made your first pull request on GitHub. You can now go back to the Hacktoberfest website and see your progress. As a bonus, your GitHub profile will appear on the repository's README file as a contributor, so make sure to have a nice profile picture. 🤩
Top comments (0)