Skip to content

Commit

Permalink
updating contributor instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
zbtirrell committed Oct 30, 2019
1 parent dedb66e commit 61742c5
Showing 1 changed file with 31 additions and 2 deletions.
33 changes: 31 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,14 @@ with that.

### Prerequisites

#### get the submodules

We rely on a few submodules, you'll need those to continue.

```
git submodule update --init --recursive
```

#### Install Node.js

If you don't already have Node.js installed, please do so first:
Expand All @@ -38,9 +46,9 @@ that with the npm `-g` flag.
npm install -g gulp-cli
```

#### Install all the things
#### Install all the NPM packages

With all of those in place, simply run:
With all of those in place, run:

```
npm install
Expand All @@ -53,6 +61,27 @@ rebuild and try again.
npm rebuild
```

#### Install composer

We use composer for some critical packages. Please [install composer](https://getcomposer.org/download/) (if you do not already have it).

#### Install composer packages

With composer in place, let's get those composer packages:
```
composer install
```

#### Install npm and composer packages in common

One of our submodules is Tribe Common, which is a shared set of libraries in use by our plugins (see also [Event Tickets](https://github.com/moderntribe/event-tickets)). It uses npm and composer as well, so, let's get those as well.

```
cd common
npm install
composer install
```

### Using Gulp

Our gulp tasks are documented in our [product-taskmanager README](https://github.com/moderntribe/product-taskmaster#gulp-tasks).

0 comments on commit 61742c5

Please sign in to comment.