From 32f74eba6de95b5057f770bc5a6441cc12d84431 Mon Sep 17 00:00:00 2001 From: Ivan Herak Date: Fri, 16 Oct 2020 10:15:33 +0200 Subject: [PATCH] NGSTACK-465 add contributing instructions --- doc/netgen/INSTALL.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/doc/netgen/INSTALL.md b/doc/netgen/INSTALL.md index 4253ab9ed..3fe831dcb 100644 --- a/doc/netgen/INSTALL.md +++ b/doc/netgen/INSTALL.md @@ -32,6 +32,34 @@ CREATE DATABASE CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_520_ci; composer create-project netgen/media-site ``` +### Create project for contribution + +If you are a developer wishing to contribute to the `media-site`, do not use the above `composer create-project` command. + +Instead, do the following: + +``` +git clone git@github.com:netgen/media-site.git +cd media-site +``` + +If you are contributing to the latest version, skip the next step. Otherwise, take care to checkout the branch you wish to contribute to, for example: + +``` +git checkout 1.9 +``` + +As either way you will not be developing on a tagged (stable) version, you need to modify `composer.json`, please add the following: + +``` +"minimum-stability": "dev", +"prefer-stable": true, +``` + +After this, you can run `composer install`, and follow the rest of the instructions. + + + Near the end of vendor installation procedure, when asked, be sure to specify the correct database connection for the site.