Skip to content

Latest commit

 

History

History
67 lines (57 loc) · 2.42 KB

CONTRIBUTING.md

File metadata and controls

67 lines (57 loc) · 2.42 KB

How to contribute to Laraberg

Reporting issues

When you have an issue with Laraberg there are a few steps you can take to increase the probability that it will get picked up as soon as possible:

  1. Do you think you can fix the issue yourself? Give it a shot! Check out how to set up a development environment below. We're open to any pull requests from small bugfixes to new features. If you're not sure that your pull request will be accepted you can contact us through a Github issue or through Gitter to discuss.
  2. Create a Github issue. Make sure to use the issue templates that are available. Following those templates makes it easier to pinpoint the issue and prevents miscommunication. If your issue does not fit into any of the issue templates try to be very specific when describing your issue. Reported issue's that consist of only one line of text are very hard to work with.

Setting up a development environment

Setting up a development environment for Laraberg is not as straightforward as it could be. Laraberg is dependent on the Gutenberg packages from WordPress, and since those are currently not available as an easy to install NPM package we have to jump through some hoops to make those packages available to Laraberg.

To install Gutenberg:

  1. Clone the Gutenberg repository in any directory.
    git clone [email protected]:WordPress/gutenberg.git
  2. CD into the directory
    cd gutenberg
  3. Checkout the latest (working) release (you can check the Laraberg release notes to see what Gutenberg verison is being used).
    git checkout vX.X.X
  4. Install it's dependencies
    npm install
  5. Build it!
    npm run build
  6. Link it!
    (sudo) npm link

Now Gutenberg is symlinked to your global node_modules folder and we can use it for the development of Laraberg.

  1. Clone Laraberg
    git clone [email protected]:VanOns/laraberg.git
  2. Install dependencies
    composer install
    yarn install
  3. Link Gutenberg packages
    npm link gutenberg
  4. Start development mode
    npm start

Now you'll have a local installation of Laraberg that you can use in any Laravel project by adding it to the composer.json:

{
   ...
   "repositories": [
       {
           "type": "path",
           "url": "{path_to_laraberg_directory}"
       }
   ],
   "require": {
       "van-ons/laraberg": "dev-{branch_name}"
   },
   ...
}