From bbd4d49c0b08c8410c25fc1523290e73f274f9f7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kristia=CC=81n=20Feldsam?= Date: Thu, 2 Mar 2017 23:45:25 +0100 Subject: [PATCH] Updated contributing guide MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Kristián Feldsam --- CONTRIBUTING.md | 20 +++++++++++++++++++- README.md | 6 ++++++ 2 files changed, 25 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a373bfa..66b6360 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,4 +2,22 @@ Contributions are welcome. Our release model uses [Git Flow approach](http://danielkummer.github.io/git-flow-cheatsheet/), so you have to base your branches on `develop` and should have name `feature/name-of-feature` or `hotfix/name-of-hotfix`. -Please contribute your translations, which are located in `lib/lang/` directory. Thank you. \ No newline at end of file +[How to fork a repo in Gitlab](https://docs.gitlab.com/ce/workflow/forking_workflow.html) + +Please contribute your translations, which are located in `lib/lang/` directory. Thank you. + +## Example of git commands to use + +``` +git clone https://git.ispconfig.org/ispconfig/module-wizard.git +cd module-wizard +git checkout -b feature/spanish-translation origin/develop +``` + +Do some work, commit changes and push to server + +``` +git add . +git commit -am "Added Spanish translation" +git push -u origin feature/spanish-translation +``` \ No newline at end of file diff --git a/README.md b/README.md index ae807bf..004c9b4 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,12 @@ clone repo using git `git clone https://git.ispconfig.org/ispconfig/module-wizar - Export results as PDF - Email results as HTML/PDF +## Contributing + +Contributions are welcome, so please contribute your translations. Thank you. + +[Contributing guide](https://git.ispconfig.org/ispconfig/module-wizard/blob/master/CONTRIBUTING.md) + ## Screenshots ![New service](https://git.ispconfig.org/ispconfig/module-wizard/raw/master/readme_images/new_service.png) -- GitLab