Setup Your Local Environment for Open Source Package Contributions

Published on by

Setup Your Local Environment for Open Source Package Contributions image

One of the most important steps to get started in contributing to an open source package is to set up your local environment.

That means you need to do the following:

  • Fork the project
  • Clone it to your local machine
  • Symlink it to a local Laravel project

Let’s walk through this process step-by-step

First, choose a Laravel package that you’d like to use and go to the Github repository. In this example, I’ll use the incredible Laravel Livewire framework.

Fork and Clone the Package

Make sure you are logged into your Github profile and click the “fork” button to fork the package.

Once you’ve forked the package, clone it to your local environment. cd into your code directory and run the following:

git clone https://github.com/[YOUR-GITHUB-NAME]/livewire.git

It is important to install the dependencies and then run the test suite to make sure everything is working properly.

composer install
./vendor/bin/phpunit

Symlink Your Version of the Package To a Local Laravel Project

Now that you’ve pulled down your forked version of the package, let’s composer require your fork of the package locally. This will allow you to make changes to your local version of the package, and they will immediately be reflected in your local Laravel project without needing to run composer update.

I always like to use a brand new Laravel project when working with open source packages. Let’s spin up a new one.

laravel new laravel6

Now you need to go to your composer.json file in the new Laravel project and add the following. Note: This assumes both your Laravel project and your forked package are in the same local directory.

"repositories": [
{
"type": "path",
"url": "../livewire"
}
]

Finally, we need to add the local package to the composer dependencies of your Laravel project.

composer require livewire/livewire @dev

This will pull in whatever branch is checked out in your local livewire repository instead of getting the vendor package from Packagist.

If you did this correctly, you’ll see a message that says Symlinking from ../livewire during the installation.

That’s it! Your environment is all prepared for you to make a pull request.

Learn More About Contributing to Open Source

If you want to learn more about contributing to open source Laravel packages, I have created a free video course where anyone can learn how to start contributing. You can sign up now at Contribute to Open Source.

Kevin McKee photo

Kevin is the creator of Contribute to Open Source where anyone can learn how to start contributing to Laravel open source packages. He is also the owner of a Laravel development firm Intellow, co-founder of a Laravel SaaS app called Padmission, and co-organizer of the LaravelSTL Meetup Group

Filed in:
Cube

Laravel Newsletter

Join 40k+ other developers and never miss out on new tips, tutorials, and more.

image
Tinkerwell

Version 4 of Tinkerwell is available now. Get the most popular PHP scratchpad with all its new features and simplify your development workflow today.

Visit Tinkerwell
Kirschbaum logo

Kirschbaum

Providing innovation and stability to ensure your web application succeeds.

Kirschbaum
Shift logo

Shift

Running an old Laravel version? Instant, automated Laravel upgrades and code modernization to keep your applications fresh.

Shift
Bacancy logo

Bacancy

Supercharge your project with a seasoned Laravel developer with 4-6 years of experience for just $2500/month. Get 160 hours of dedicated expertise & a risk-free 15-day trial. Schedule a call now!

Bacancy
LoadForge logo

LoadForge

Easy, affordable load testing and stress tests for websites, APIs and databases.

LoadForge
Paragraph logo

Paragraph

Manage your Laravel app as if it was a CMS – edit any text on any page or in any email without touching Blade or language files.

Paragraph
Lucky Media logo

Lucky Media

Bespoke software solutions built for your business. Partner with Lucky Media, your favorite Laravel Development Agency!

Lucky Media
Lunar: Laravel E-Commerce logo

Lunar: Laravel E-Commerce

E-Commerce for Laravel. An open-source package that brings the power of modern headless e-commerce functionality to Laravel.

Lunar: Laravel E-Commerce
Laravel Forge logo

Laravel Forge

Easily create and manage your servers and deploy your Laravel applications in seconds.

Laravel Forge
Oh Dear logo

Oh Dear

Oh Dear is the best all-in-one monitoring tool for all your Laravel apps.

Oh Dear
Tinkerwell logo

Tinkerwell

The must-have code runner for Laravel developers. Tinker with AI, autocompletion and instant feedback on local and production environments.

Tinkerwell

The latest

View all →
Get insights into all your Laravel notifications with Paragraphs new package image

Get insights into all your Laravel notifications with Paragraphs new package

Read article
FrankenPHP v1.0 is Here image

FrankenPHP v1.0 is Here

Read article
Self-healing URLs in Laravel image

Self-healing URLs in Laravel

Read article
Laravel 10.35 Released image

Laravel 10.35 Released

Read article
Solve n+1 queries in PHP with Scout APM image

Solve n+1 queries in PHP with Scout APM

Read article
Show Outdated Composer Dependencies in Laravel Pulse image

Show Outdated Composer Dependencies in Laravel Pulse

Read article