From 055228f5d31987bed9d1b69d3f82dc4fdea1d19c Mon Sep 17 00:00:00 2001 From: Uladzimir Tsykun Date: Sun, 29 Jan 2023 01:47:45 +0100 Subject: [PATCH] Base setup env instruction for contribution --- .gitignore | 3 +++ CONTRIBUTING.md | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 40 insertions(+) create mode 100644 .gitignore create mode 100644 CONTRIBUTING.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..5cf9a2c --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +/composer.lock +/phpunit.xml +/vendor/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..4142e3e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,37 @@ +# Contributing + +Everyone is welcome to contribute code. + +### 1. Development environment. + +#### Requirements + +- PHP >= 7.2 +- Symfony application. + +### 2. Creating Symfony Applications or use existing + +See [symfony docs](https://symfony.com/doc/current/setup.html) + +``` +git clone git@github.com:YOUR_GITHUB_NAME/packeton.git +git checkout -b fix/patch-1 +``` + +### 3. Make a fork, install the dependencies. + +Make a fork on GitHub, and then create a pull request to provide your changes. + +Run composer install and make symlink with repo. + +``` +cd app +composer require okvpn/cron-bundle + +git clone https://github.com/vtsykun/cron-bundle.git + +rm -rf vendor/okvpn/cron-bundle +ln -s $PWD/cron-bundle vendor/okvpn/cron-bundle + +``` +