Skip to content

Latest commit

 

History

History
48 lines (32 loc) · 3.55 KB

firstContribution.md

File metadata and controls

48 lines (32 loc) · 3.55 KB

Getting started with your first contribution to an open-source project on GitHub can be an exciting and rewarding experience. Here is a step-by-step guide to help you through the process:

1. Create a GitHub account:

If you don't have a GitHub account, sign up for one at github.com.

2. Explore GitHub:

Familiarize yourself with GitHub by exploring repositories, understanding how issues and pull requests work, and checking out different projects.

3. Choose a project:

Select a project that aligns with your interests and skills. Look for projects with a good first-timer-friendly label, which indicates issues suitable for beginners.

4. Read the contribution guidelines:

Every project usually has contribution guidelines. Find and read them carefully to understand the project's coding standards, commit message conventions, and other important information.

5. Set up your development environment:

Follow the project's instructions for setting up your local development environment. This may involve installing specific software or dependencies.

6. Find an issue to work on:

Look for issues labeled as "good first issue" or something similar. These are usually tasks that are suitable for newcomers. Read through the issue description and comments to understand the context.you can also create your new issues by clicking on new issue button(this would depend on the contribution guidelines of the organisation ).

7. Fork the repository:

On the project's GitHub page, click the "Fork" button in the top-right corner. This creates a copy of the project in your GitHub account.

8. Clone your fork:

Clone the forked repository to your local machine by going to the code button and copying the url code . Now go to vs code and click on clone git repository and paste the url.this will create a copy of the project at your local machine.

9. Create a branch:

Create a new branch for your contribution. firtsly go to main present at the footer of vs code , then in the input click on "create new branch" and then type the name of the new branch and press Enter . This helps keep your changes isolated from the main codebase.

10. Make changes:

Make the necessary changes in your local machine. Follow the project's coding standards and guidelines.

11. Commit your changes:

Now you have to Commit your changes to your local branch by going to Source Control icon at the sidebar . now type the relevant commit message and click on Commit option.A dialog box will appear , click on yes . now since you have created a new branch you will get an option saying "Publish Branch".Click on it.

12. Push changes to GitHub:

Now after pressing the commit button , click on Sync changes and click on "Ok" in the dialog box.

13. Create a pull request (PR):

On the GitHub page of your fork, click the "New pull request" button. Compare your branch with the main branch of the original repository. Provide a descriptive title and comment about your changes.

14. Wait for feedback:

The project maintainers or other contributors may review your PR and provide feedback. Be responsive to comments and make necessary changes.

15. Celebrate your contribution:

Once your changes are accepted and merged, celebrate your first open-source contribution!

Remember that the contribution process may vary slightly between projects, so always refer to the specific guidelines provided by the project you're contributing to.Although the fundamentals remains the same.