- When contributing to this repository, please first discuss the change you wish to make via an issue!
- Create a branch with a descriptive name, e.g.
feature-mysql-support
orfix-custom-path-not-working
. - See Pull Request Template to see what your pull request should look like.
- Use concise commit messages, e.g.
[FIX] Fixed x not doing b
. - Use the PSR-2 Coding Standard.
- When you have made changes to the front-end, run
$ npm run prod
once before creating a pull request. - Write tests for new features. No tests means no merge.
- Create or use an existing Laravel project, as long as it has a valid database connection.
- Forking Prequel
- Run
composer require protoqol/prequel
and usevendors/protoqol/prequel
as your workspace. - Run
git clone git@github.com:Protoqol/Prequel.git packages/prequel/
and add"Protoqol\\Prequel\\": "packages/prequel/src/"
to your composer.json so it looks like this
"autoload": { "psr-4": { "App\\": "app/", "Protoqol\\Prequel\\": "packages/prequel/src/" }, }
- Run
- In your Laravel test project run
php artisan vendor:publish --tag=config --provider=Protoqol\Prequel\PrequelServiceProvider
to publish the assets. - Navigate to Prequel's root folder.
- Create a new branch with a descriptive name, no master branch!
- When making changes to the front-end (.vue files), run
$ npm run watch
to create a hot-reloading server where you can see your changes live. - When done with your feature/fix and you have made changes to any .vue file, run
$ npm run prod
to create a final build. - You're ready to create a pull request! See Pull Request Template for information.