Contributing about wink

[Jhnbrn90]

Hi @hilmanski
In principal you should never have to edit files in the vendor directory. Changes made in files within this directory are likely discarded when you run composer install or composer update.

My approach to contributing to a package is as follows.

1. Make sure to fork the GitHub repository first
2. Clone the repository to your local machine. I have a special "packages" folder
3. Install a fresh Laravel project in a "websites" folder
4. In your Laravel's composer.json file, add the package using the path repository method you mentioned. I have written a detailed section about this method: "Importing the package locally"
5. Make sure to use a different "name" in your composer.json file, as composer first checks Packagist and if there are no results, it will try to find the package locally next.
6. Require the package in your Laravel application using composer require {the name your used in your composer file}.

Now, when you require the package within your Laravel application it will use a symlink to that package in your "packages" folder and any changes you make to the package are directly reflected within the Laravel application.

[themsaid]

here: https://github.com/writingink/wink/blob/master/CONTRIBUTING.md

[hilmanski]

Hi @themsaid
this is my first time, contributing to laravel package.

What i did:

1. Install new Laravel
2. Add inside composer.json: the "path Repository method" and require wink "*@dev"

when i run composer update,
it shows this error:
Theurl supplied for the path (./../wink) repository does not exist

So i make a new "wink" directory outside this new laravel app.

1. is that right? the wink folder location
2. where should i edit the wink's code? inside vendor directly?

[hilmanski]

Thanks John for the very detail guide.
It can become one of your blog post :) so other people can find it easier in the future

cheers