| id | title | sidebar_label | keywords | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
how-to-contribute-to-open-source |
How to Contribute to Open Source |
How to Contribute to Open Source |
|
In this chapter, we'll guide you through the process of how to contribute to open source.
One of the first challenges you might face when getting learning how to contribute in open source is finding a project to contribute to. Here are some tips to help you discover projects that align with your interests and skills:
-
Browse GitHub and GitLab: Both GitHub and GitLab host a vast number of open source projects. You can use their search functionality to find projects based on specific keywords, programming languages, or topics.
-
Follow your interests: Think about the tools, frameworks, and libraries you use or are interested in learning more about. Many of these projects are open source and welcome contributions from the community.
-
Join open source communities: There are numerous online communities, forums, and chat platforms dedicated to open source development. By joining these communities, you can connect with other developers, discover new projects, and find collaboration opportunities. In the Community, for example, we share good first issues, cool GitHub projects, and issues we have open on our repositories.
-
Leverage OpenSauced: OpenSauced is a platform that helps developers discover and contribute to open source projects. By using OpenSauced, you can find projects that align with your interests, skills, and goals.
:::tip
To understand how to contribute in open source, it’s important to start by familiarizing yourself with the project’s guidelines and community standards.
:::
OpenSauced is a powerful tool for finding open source projects to contribute to. To get started with OpenSauced, follow these steps:
-
Sign up for an account: Visit https://www.opensauced.pizza/ and sign up for an account using your GitHub credentials.
During the signup process, you'll be asked to pick some interests and set your timezone. This will help OpenSauced recommend projects that align with your interests and schedule.
-
Explore dashboard: Once you've signed up, you'll be taken to your dashboard, where you can view your current projects, goals, and contributions. Clicking "Explore" in the header will take you to the Explore dashboard where you can browse projects based on your interests and skills.
-
Search for projects: In the Explore dashboard, you can see a list of repositories and their relevant activity levels and engagement levels that are currently trending. You can also search for projects by typing in the search bar. You can search for projects by name, description, or topic and use this tool to find something that resonates with you.
-
Save projects to your Insights pages: When you find projects you're interested in, you can add them to "Insights" pages that give you more details about the activity over the projects. Or, if you'd rather just dive in and contribute, you can skip to the next step.
-
Start contributing: When you click on the name of a repository, you'll be taken to its GitHub page, where you can explore issues that are open and ready for contribution, knowing that the community around this project is active and your contributions will be welcomed.
Understanding how to contribute to open source involves not only coding but also participating in discussions, reporting bugs, and improving documentation. By using OpenSauced, you can streamline the process of finding open source projects to work on and focus on contributing to the projects that align with your interests and goals.
When you're interested in contributing to a new open source project, it's important to familiarize yourself with the project's guidelines, conventions, and workflow and take the initiative to onboard yourself.
Here are some tips to help you onboard successfully:
-
Read the project's documentation: Read the README file, contributing guidelines, and code of conduct to familiarize yourself with the project. They will help you understand the project's goals, requirements, and expectations for contributors.
-
Start small: When you're new to a project, it's a good idea to start with small, manageable tasks, such as fixing bugs, adding tests, or updating documentation. This will help you become familiar with the codebase and development workflow without getting overwhelmed.
-
Join the open source community: Many open source projects have online communities, forums, or chat platforms where developers can ask questions, share knowledge, and collaborate. To learn how to contribute to open source, you can connect with other contributors, learn from their experiences, and get help with any issues you encounter.
-
Ask for help: If you need clarification or encounter a problem, don't hesitate to ask for help. Open source communities are generally supportive and welcoming; other contributors will gladly assist you.
-
Be patient and persistent: Onboarding in a new project can be challenging, especially if you're new to open source development. Be patient, and don't be discouraged by setbacks or mistakes. You'll become more comfortable and confident in your contributions with persistence and practice.
So, you've onboarded yourself in the project. Now, you can prepare to contribute by following these steps:
We touched on this briefly in the previous section. But it's worth revisiting because it's important to read the project's documentation thoroughly before you start contributing.
Start by reading the README and familiarizing yourself with the project. A README contains an introduction to the project, such as how it works, its purpose, the tech stacks it uses, and how to set up and run the local environment.
Once you're familiar with the project and interested in contributing, don't jump in without reading the contributing guidelines. These guidelines are in the CONTRIBUTING file at the project's root. If the file is unavailable, you can find them in the README.
Every project has different contributing rules. These rules are written in the contributing guidelines, which contain information on how to claim and work with issues, create pull requests, and preferable methods of communication. For example, you can look at the OpenSauced Contributing Guidelines.
Some projects also have conventions, such as code and Markdown style, how to write commit messages, pull requests and issue titles, and so on. You might find these in their style guide or contributing guidelines.
:::tip
Read the contributing guidelines carefully to understand how the project receives contributions. Following these guidelines will make your contribution process smoother.
:::
After reading the documentation, you can start looking for issues labeled as "good first issue" or "beginner-friendly" that are suitable for your skill level. When choosing which issues to work on, consider your interests, skill level, and available time.
Issues can be seen as proposals for changes. Suppose you want to report a bug or have ideas for a feature or improvement of the project or its documentation and want to propose them. In that case, you can create an issue to propose your intention. Read this blog post to learn how to fill in issue forms.
In open source, it is crucial to accompany a pull request with an issue for several reasons:
-
Context and Discussion: Giving context to your proposal and discussing it with the maintainers can help to ensure that the proposed change is aligned with the project's goals, architecture, and roadmap. This discussion helps set clear expectations and increases the chance of your pull request being accepted.
-
Documentation and Tracking: Issues act as a form of documentation, providing a historical record of the identified problem, proposed solution, and decision-making process behind the change. They help maintainers track the project's progress and prioritize tasks. At the same time, they also allow other contributors to understand the context and reasons behind the changes introduced in the pull request.
-
Reducing Back-and-Forth Communication: Discussing and agreeing upon the proposed changes in advance through the issue can reduce the back-and-forth communication during the pull request review process. This can save both your time and the maintainers' time.
-
Avoiding Unnecessary Work: Creating an issue allows maintainers to provide early feedback on the proposed change. They can advise if a similar issue exists, if the proposed change aligns with the project's goals, or if alternative approaches are preferable. This helps you avoid wasting time and effort working on something that may not be accepted because it conflicts with existing plans.
-
Avoiding Spam Pull Requests: Unsolicited (pull requests without an issue) and unwanted pull requests may be marked as spam because they're seen as introducing irrelevant, low-quality, or harmful changes to the project's codebase. Having your pull request marked as spam can lead to rejection, lost contribution opportunities, and potentially damage your reputation.
Certain projects may have specific rules regarding the assignment of issues. Some projects may require you to ask permission before working on an issue, while others allow you to assign yourself to an issue. That's why reviewing the project's contributing guidelines is essential to knowing how to claim issues.
If the contributing guidelines do not state how to claim an issue, you can ask the maintainers to assign it to you. This will ensure no duplication and that your contribution is aligned with the project's goals and requirements.
You can leave a comment on the issue, like, "Can I please be assigned to this issue?" When the maintainer has assigned you, you'll notice that your username is now under the "Assignees" section.
Once a maintainer has assigned you an issue, the next step is to work on the changes. Here's a general workflow of the process:
Forking a repository means creating a copy of the repository under your GitHub account. It allows you to push changes to the remote codebase without affecting the original project.
Cloning your forked repository means making a copy of your forked repository to your local machine. Run the following command in your terminal:
git clone https://github.com/YOUR-USERNAME/REPOSITORY-NAME.gitReplace "YOUR-USERNAME" with your GitHub username and "REPOSITORY-NAME" with the repository's name.
Before making any changes, create a new branch in your local repository to work on your contribution. Creating a new branch is the best practice in open source because it keeps your changes separate from the main branch.
You can create a new branch using the following command:
git checkout -b YOUR-BRANCH-NAMEReplace "YOUR-BRANCH-NAME" with a descriptive name for your branch, such as "fix-bug-123" or "add-new-feature".
Now that you have a new branch, you can make changes to the codebase. Always follow the project's coding guidelines and conventions.
You should always run and check your changes in your local environment, regardless of how small they are. This is important to ensure they work as expected and won't break production.
You can find the instructions on how to run a project locally in the README file or in the contributing guidelines.
Once you've made your changes, add your changes to the staging area and commit them with these commands:
git add .
git commit -m "Your commit message"Replace "Your commit message" with a brief description of your changes.
Push your changes to your forked repository on GitHub by running the following command:
git push origin YOUR-BRANCH-NAMEReplace "YOUR-BRANCH-NAME" with the name of your branch.
Once you've pushed your changes, you can now create a pull request. To create a pull request:
- Navigate to the original project's repository on GitHub.
- Click the "Compare & pull request" button.
- Fill in all required information in the template.
- Click the "Create pull request" button.
Most projects provided a pull request template that is shown and needs to be filled in Markdown. This template guides you in providing all the information maintainers need to review your pull request.
It can be challenging to read and fill in a pull request template. Here is some tips on how to fill one:
-
Preview Mode
Click the "Preview" tab to see the sections you must fill in before you do so. It will be easier for you to notice them in this mode, but note that you cannot edit them in preview mode.
Here is an example of a pull request template at OpenSauced in preview mode:
-
Headings
Get back to the writing mode by clicking the "Write" tab. Pay attention to the headings with
#symbols. You need to provide information right under these headings. -
Comments
The instructions on what information you must provide are usually written in the comments under each heading. You need to read and follow all instructions thoroughly.
:::tip
When filling in the information, write it below the comment so you can still see and follow the instructions.
:::
Here is the template in Markdown. Now, pay attention to the headings and the comments as we discussed:
## Description <!-- Please do not leave this blank This PR [adds/removes/fixes/replaces] the [feature/bug/etc]. --> ## Related Tickets & Documents <!-- Please use this format link issue numbers: Fixes #123 https://docs.github.com/en/free-pro-team@latest/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword --> ## Mobile & Desktop Screenshots/Recordings <!-- Visual changes require screenshots --> ## Steps to QA <!-- Please provide some steps for the reviewer to test your change. If you have wrote tests, you can mention that here instead. 1. Click a link 2. Do this thing 3. Validate you see the thing working --> ## Tier (staff will fill in) - [ ] Tier 1 - [ ] Tier 2 - [ ] Tier 3 - [ ] Tier 4 ## [optional] What gif best describes this PR or how it makes you feel? <!-- note: PRs with deleted sections will be marked invalid --> <!-- For Work In Progress Pull Requests, please use the Draft PR feature, see https://github.blog/2019-02-14-introducing-draft-pull-requests/ for further details. For a timely review/response, please avoid force-pushing additional commits if your PR already received reviews or comments. Before submitting a Pull Request, please ensure you've done the following: - 📖 Read the Open Sauced Contributing Guide: https://github.com/open-sauced/.github/blob/main/CONTRIBUTING.md. - 📖 Read the Open Sauced Code of Conduct: https://github.com/open-sauced/.github/blob/main/CODE_OF_CONDUCT.md. - 👷♀️ Create small PRs. In most cases, this will be possible. - ✅ Provide tests for your changes. - 📝 Use descriptive commit messages. - 📗 Update any related documentation and include any relevant screenshots. -->
-
Don't skip and delete anything in the template
What's important is that you must fill in every section in the template that doesn't say "optional" or doesn't mean for the core team or staff to fill in. Also, you must never delete or modify the template, even if you think a section doesn't apply to your contribution.
If a section is irrelevant to your changes, leave a comment explaining why it's irrelevant or provide a brief "N/A" response. If you still need help with what to fill in, look at the previous pull requests and see how other contributors have done that.
Every project is unique. Each has its own pull request template structure and requires specific information to be provided. However, all projects typically require the following:
-
Title
Add a short and clear title that describes the change that you make. For example, "Fix: Color contrast in the landing page".
-
Description
Explain your changes in as much detail as possible. What did you fix? How did you fix it? Did you add a new function or modify a function? If there are several changes, consider using bullet points and providing links to the resources you use to back up your changes.
Here is an example:
## Description <!-- Please do not leave this blank This PR [adds/removes/fixes/replaces] the [feature/bug/etc]. --> This PR fixes the long repos' names that are partially stacked at the back of another name in the search input of the Explore tab. The changes made here: - Add Tailwind className: - [`truncate`](https://tailwindcss.com/docs/text-overflow#truncate) to truncate overflowing text. - [`tracking-tighter`](https://tailwindcss.com/docs/letter-spacing) to reduce letter spacing for better space. - `inline-block` to the `<span>` . - Remove Tailwind classNames: - `overflow-hidden` as it's [included in the `truncate`](https://tailwindcss.com/docs/text-overflow). - `break-all` as we don't want to add line breaks.
-
Related issue(s)
Most projects don't receive unsolicited pull requests (pull requests that are not accompanied by an issue). One reason is to avoid spam pull requests that might introduce irrelevant, low-quality, or harmful changes to the project's codebase.
So, when you create a pull request, you want to include the related issue number. Add the keyword "Closes," "Fixes," or "Resolves" in front of the issue number, for example, "Closes #123".
Linking a pull request to an issue will automatically close the issue once the pull request gets merged.
You can find the issue number right after the title, as shown below.
:::info
Only add the supported keyword and the issue number here. Adding more words will prevent the issue from being closed automatically.
:::
-
Screenshots or screen recordings
If your changes relate to UI improvement, consider adding screenshots or screen recordings to show the before-and-after changes.
After submitting your pull request, the project maintainers may provide feedback or request changes. Be sure to respond promptly and address any concerns or suggestions they may have.
By following these steps, you'll be able to submit your contributions to open source projects and collaborate with other developers to improve the codebase.
After your contribution has been submitted and reviewed, one of the following outcomes may occur:
-
Your contribution is accepted: If your contribution is approved by the project maintainers, it will be merged into the main branch of the codebase.
Congratulations! Your work is now part of the project, and you've made a valuable contribution to the open source community. -
Your contribution requires changes: Sometimes, the project maintainers may request changes to your contribution before it can be accepted. This could be due to coding issues, conflicts with other changes, or a need for additional documentation. In this case, make the requested changes and resubmit your pull request.
-
Your contribution is rejected: In some cases, your contribution may not align with the project's goals or requirements, or it may not be the best solution to a problem. If your contribution is rejected, don't be discouraged. Take the feedback you received as an opportunity to learn and improve. You can always try contributing to another project or submitting a different contribution to the same project.
Now that you know how to find and contribute to open source projects, it's time to put your skills into practice. Let's do this by contributing to OpenSauced's guestbook repository.
You'll need to have these tools donwloaded and installed on your local machine:
-
Create an issue by following these instructions:
-
Click the "Issues" tab on the top bar.
-
Click the green "New issue" button at the top right.
-
Click the "Get started" button to add contributors.
-
Add a title, e.g.,
Feature: Add @GITHUB-USERNAME as a contributor.
Change "@GITHUB-USERNAME" to your GitHub username. -
Complete the form. Read the instructions under each input label and fill in the textareas using the example shown in the screenshot below with the red line.
-
Click the "Submit new issue" button.
-
-
Fork the guestbook repository.
-
Clone your forked repository to your computer.
-
Run
npm installto install the dependencies. -
Create a new branch and use a descriptive name related to your contribution — for example,
feat/add-alice. -
Run
npm run contributors:addin your terminal.Follow the instructions to add yourself to the guestbook. After you finish and click enter, you must click enter again to confirm your choices.
-
Run
npm run contributors:generatein your terminal to generate the guestbook on the README. -
Copy and paste the Markdown of the README in Markdown Live Preview and take a screenshot of your profile being generated as the example below. You will need this later when creating a pull request.
:::tip
If you don't see your profile in the "Contributors" section, zoom out the screen until you can see it before taking a screenshot.
:::
-
Run
git logto check if your changes have been automatically committed. To close the log, pressQ.Here's what you should expect to see as your commit message:
docs: add @your_username as a contributor
-
Push the commit to your forked repository with this command:
git push -u origin branch-name
-
Go to your forked repository on GitHub. Create a pull request with the title
feat: Add <@github-username> as a contributorand fill in all areas in the pull request template. Read the Fill In a Pull Request Template section to help you complete the template.:::warning
Your pull request will be marked as invalid and may be closed if the template is incomplete.
:::
Here's what a completed Pull Request Template for the guestbook looks like. Make sure yours looks like this, updated with your unique information.
Congratulations on your first contribution! 🎉
:::tip
If you're ready for your next contribution, check out the pizza-verse repository and follow the contribution guidelines.
:::
It is highly recommended that you update your remote and local branches habitually. That way, your branch will have the latest update when merged into the main branch of the original (upstream) repository.
The best times to update your branches are before you push your changes to the remote repository and while you're waiting for your pull request to be reviewed.
First, you must update your forked (origin) repository:
- Go to your forked repository on GitHub.
- Click the "Sync fork" button.
- Click the green "Update branch" button.
Then, pull the latest changes in the main branch in the origin repository to update your local working branch by following these steps in your terminal:
-
Go to your working branch.
git checkout YOUR-BRANCH-NAME
-
Pull the latest changes with this command:
git pull origin main
Merge conflicts are something you'll commonly encounter when contributing to an open source project. When two branches have made different changes to the same line(s) in the same file(s), Git cannot automatically determine which change to keep, resulting in a conflict.
When a merge conflict occurs, Git adds conflict markers (<<<<<<<, =======, and >>>>>>) to indicate the conflicting lines from different branches. Everything between the <<<<<<< and ======= is the changes that you worked on (current changes). And everything between the ======= to >>>>>>> is the incoming changes from the remote main branch.
You need to pay attention to the conflicts and decide how you want to resolve them. You can keep only your change, incoming change, or both changes.
Some open source repositories, such as OpenSauced's guestbook and pizza-verse repositories, have high contribution activities in the same files that can cause merge conflicts.
Below are some tips to prevent you from resolving merge conflicts repeatedly when contributing to open source projects:
Ensure you follow the instructions in the project's README or Contributing Guide, and don't miss any step.
Complete the template form and fill in all areas when creating a pull request.
If a repository doesn't provide you with a pull request template, you need to have these in your pull request form:
-
A descriptive title: A descriptive title would help maintainers and other contributors gain an idea of what your contribution is.
Consider using the following method to write your title:type: brief description of your contribution. For example,fix: color contrast issue on the navbar,feat: create a warning button, etc. -
A clear description of your pull request: Describe your pull request clearly. Consider explaining your changes, thoughts behind the solution, etc. A clear description gives maintainers and other contributors insight into the details of your changes. Here is an example of a clear description in a pull request.
-
The link to the related issue: Linking a pull request to the addressed issue will close the linked issue automatically when the pull request gets merged. This makes it easier for maintainers to keep their projects organized.
-
A screenshot or screen recording when you make a UI change: Providing screenshots or screen recordings will make it easier for maintenance to visualize your changes and review your pull request.
If a branch has merge conflicts that must be resolved, the merge button is automatically disabled. So, maintainers are not able to merge the pull request.
When you notice merge conflicts in your pull request or if a maintainer asks you to resolve merge conflicts, fix them immediately. The sooner you resolve the conflicts, the sooner maintainers can review and merge your pull request.
Since the primary purpose of the guestbook is to add your name to .all-contributorsrc and the README.md files, there is a high chance that you will encounter merge conflicts.
The conflicts happen when maintainers have merged pull requests before yours while you're working on your changes or waiting for your pull request to be reviewed. And you need to resolve them before your pull request can be merged.
Before resolving merge conflicts, you must first update your branches. Then, follow these steps:
-
In the
.all-contributorsrcfile:- Click the "Accept Both Change" option on the top of your workspace in VS Code.
- Move your profile details to the end of the contributors' array and fix anything necessary.
-
In the
README.mdfile:- Click the "Accept Incoming Change" option on the top of your workspace in VS Code for each conflict in this file.
-
Run
npm run contributors:generate.You will now see that the all contributors badge has been incremented, and your profile is generated at the end of the contributors' list in the
README.mdfile. -
Add and commit your changes.
git commit -am "Resolve merge conflicts" -
Push your commits to your remote branch.
git push
As you continue to contribute to open source projects, you'll gain valuable experience, develop new skills, and build a strong portfolio of work. In the next chapter, we'll discuss some strategies for getting started with open source contributions, gaining traction in your contributions, and developing your open source resume using OpenSauced.