From 533925522c42ccccd0d9a3dedebbfd3ef9fe9e01 Mon Sep 17 00:00:00 2001 From: Mahmoud Zalt Date: Wed, 3 Aug 2016 13:08:00 +0300 Subject: [PATCH] add CONTRIBUTING.md --- CONTRIBUTING.md | 130 ++++++++++++++++++++++++++++++++++++++++++ README.md | 1 + php-fpm/Dockerfile-56 | 6 ++ php-fpm/Dockerfile-70 | 6 ++ workspace/Dockerfile | 6 ++ 5 files changed, 149 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..9e1cedbc --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,130 @@ + + +# Contributing to LaraDock + +Your contribution is more than welcome. Let's keep LaraDock amazing. + + +### Got a Question or Problem? + +If you have questions about how to use LaraDock, please direct your questions to the discussion on [Gitter](https://gitter.im/LaraDock/laradock). If you beleave your question could help others, then consider opening an [Issue](https://github.com/laradock/laradock/issues) (it will be labeled as Question). + +### Found an Issue? +If you find a bug in the source code or a mistake in the documentation, you can help us by +submitting an [Issue](https://github.com/laradock/laradock/issues). Even better you can submit a Pull Request with a fix. + +### Want a Feature? +You can request a new feature by submitting an [Issue](https://github.com/laradock/laradock/issues) (it will be labeled as Feature Suggestion). If you would like to implement a new feature then consider submitting a Pull Request. + + +## Coding Guidelines + +### Support new Software + +* Create folder with the software name. + +* Add a `Dockerfile`, write your code there. + +* You may add additional files in the software folder. + +* Add the software to the `docker-compose.yml` file. + +* Make sure you follow our commenting style. + +* Add the software in the `Readme`. + +### Edit existing Software + +* Open the software (container) folder. + +* Edit the files you want to update. + +* **Note:** If you want to edit the base image of the `Workspace` or the `php-fpm` Containers, +you need to edit their Dockerfiles from their Github repositories. For more info read their Dockerfiles comment on the LaraDock repository. + +* Make sure to update the `Readme` incase you made any changes. + +## Issue/PR Submission Guidelines + +### Submitting an Issue +Before you submit your issue search the archive, maybe your question was already answered. + +If your issue appears to be a bug, and hasn't been reported, open a new issue. +Help us to maximize the effort we can spend fixing issues and adding new +features, by not reporting duplicate issues. + + + +### Submitting a Pull Request (PR) +Before you submit your pull request consider the following guidelines: + +* Search [GitHub](https://github.com/LaraDock/laradock/pulls) for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort. + +* Make your changes in a new git branch: + + ```shell + git checkout -b my-fix-branch master + ``` +* Commit your changes using a descriptive commit message. + +* Push your branch to GitHub: + + ```shell + git push origin my-fix-branch + ``` + +* In GitHub, send a pull request to `laradock:master`. +* If we suggest changes then: + * Make the required updates. + * Commit your changes to your branch (e.g. `my-fix-branch`). + * Push the changes to your GitHub repository (this will update your Pull Request). + +> If the PR gets too outdated we may ask you to rebase and force push to update the PR: + +```shell +git rebase master -i +git push origin my-fix-branch -f +``` + +*WARNING. Squashing or reverting commits and forced push thereafter may remove GitHub comments on code that were previously made by you and others in your commits.* + + + + + + +### After your pull request is merged + +After your pull request is merged, you can safely delete your branch and pull the changes +from the main (upstream) repository: + +* Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows: + + ```shell + git push origin --delete my-fix-branch + ``` + +* Check out the master branch: + + ```shell + git checkout master -f + ``` + +* Delete the local branch: + + ```shell + git branch -D my-fix-branch + ``` + +* Update your master with the latest upstream version: + + ```shell + git pull --ff upstream master + ``` + + + + + +
+### Happy Coding :) \ No newline at end of file diff --git a/README.md b/README.md index d9388ddd..49d5238b 100644 --- a/README.md +++ b/README.md @@ -987,6 +987,7 @@ Moving from Docker Toolbox (VirtualBox) to Docker Native (for Mac/Windows). Requ This little project was built by one man who has a full time job and many responsibilities, so if you like this project and you find that it needs a bug fix or support for new software or upgrade any container, or anything else.. Do not hesitate to contribute, you are more than welcome :) +#### Read our [Contribution Guidelines](https://github.com/LaraDock/laradock/blob/master/CONTRIBUTING.md) ## Help & Questions diff --git a/php-fpm/Dockerfile-56 b/php-fpm/Dockerfile-56 index 65b1bb73..07168d9c 100644 --- a/php-fpm/Dockerfile-56 +++ b/php-fpm/Dockerfile-56 @@ -3,6 +3,12 @@ # Image Setup #-------------------------------------------------------------------------- # +# To edit the 'php-fpm' base Image, visit its repository on Github +# https://github.com/LaraDock/php-fpm +# +# To change its version, see the available Tags on the Docker Hub: +# https://hub.docker.com/r/laradock/php-fpm/tags/ +# FROM laradock/php-fpm:5.6--1.0 diff --git a/php-fpm/Dockerfile-70 b/php-fpm/Dockerfile-70 index 1a994eff..88c85f2e 100644 --- a/php-fpm/Dockerfile-70 +++ b/php-fpm/Dockerfile-70 @@ -3,6 +3,12 @@ # Image Setup #-------------------------------------------------------------------------- # +# To edit the 'php-fpm' base Image, visit its repository on Github +# https://github.com/LaraDock/php-fpm +# +# To change its version, see the available Tags on the Docker Hub: +# https://hub.docker.com/r/laradock/php-fpm/tags/ +# FROM laradock/php-fpm:7.0--1.0 diff --git a/workspace/Dockerfile b/workspace/Dockerfile index ab79cc3a..ab5a718a 100644 --- a/workspace/Dockerfile +++ b/workspace/Dockerfile @@ -3,6 +3,12 @@ # Image Setup #-------------------------------------------------------------------------- # +# To edit the 'workspace' base Image, visit its repository on Github +# https://github.com/LaraDock/workspace +# +# To change its version, see the available Tags on the Docker Hub: +# https://hub.docker.com/r/laradock/workspace/tags/ +# FROM laradock/workspace:1.0