diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a373bfada8e25beb0004d2d13bb0ae850e9e7290..66b63602a4b5f1dd2d75d33efe6da3f766057fd6 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 ae807bfac7290440489411c26670ead77fb06fef..004c9b4cff885463bd35fee92fbe79b8b1d4db7b 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)