Skip to content

Commit 5210ca7

Browse files
authored
Merge pull request laradock#4 from LaraDock/master
Just update
2 parents 5ebb061 + a30bf83 commit 5210ca7

21 files changed

Lines changed: 987 additions & 417 deletions

.editorconfig

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
root = true
2+
3+
[*]
4+
end_of_line = lf
5+
insert_final_newline = true
6+
7+
[*]
8+
charset = utf-8
9+
10+
[{Dockerfile,docker-compose.yml}]
11+
indent_style = space
12+
indent_size = 4

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
/logs
2+
/data
23
.env

CONTRIBUTING.md

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
2+
3+
# Contributing to LaraDock
4+
5+
Your contribution is more than welcome. Let's keep LaraDock amazing.
6+
7+
8+
### Got a Question or Problem?
9+
10+
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).
11+
12+
### Found an Issue?
13+
If you find a bug in the source code or a mistake in the documentation, you can help us by
14+
submitting an [Issue](https://github.com/laradock/laradock/issues). Even better you can submit a Pull Request with a fix.
15+
16+
### Want a Feature?
17+
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.
18+
19+
20+
## Coding Guidelines
21+
22+
### Support new Software
23+
24+
* Create folder with the software name.
25+
26+
* Add a `Dockerfile`, write your code there.
27+
28+
* You may add additional files in the software folder.
29+
30+
* Add the software to the `docker-compose.yml` file.
31+
32+
* Make sure you follow our commenting style.
33+
34+
* Add the software in the `Readme`.
35+
36+
### Edit existing Software
37+
38+
* Open the software (container) folder.
39+
40+
* Edit the files you want to update.
41+
42+
* **Note:** If you want to edit the base image of the `Workspace` or the `php-fpm` Containers,
43+
you need to edit their Dockerfiles from their Github repositories. For more info read their Dockerfiles comment on the LaraDock repository.
44+
45+
* Make sure to update the `Readme` incase you made any changes.
46+
47+
## Issue/PR Submission Guidelines
48+
49+
### Submitting an Issue
50+
Before you submit your issue search the archive, maybe your question was already answered.
51+
52+
If your issue appears to be a bug, and hasn't been reported, open a new issue.
53+
Help us to maximize the effort we can spend fixing issues and adding new
54+
features, by not reporting duplicate issues.
55+
56+
57+
58+
### Submitting a Pull Request (PR)
59+
Before you submit your pull request consider the following guidelines:
60+
61+
* 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.
62+
63+
* Make your changes in a new git branch:
64+
65+
```shell
66+
git checkout -b my-fix-branch master
67+
```
68+
* Commit your changes using a descriptive commit message.
69+
70+
* Push your branch to GitHub:
71+
72+
```shell
73+
git push origin my-fix-branch
74+
```
75+
76+
* In GitHub, send a pull request to `laradock:master`.
77+
* If we suggest changes then:
78+
* Make the required updates.
79+
* Commit your changes to your branch (e.g. `my-fix-branch`).
80+
* Push the changes to your GitHub repository (this will update your Pull Request).
81+
82+
> If the PR gets too outdated we may ask you to rebase and force push to update the PR:
83+
84+
```shell
85+
git rebase master -i
86+
git push origin my-fix-branch -f
87+
```
88+
89+
*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.*
90+
91+
92+
93+
94+
95+
96+
### After your pull request is merged
97+
98+
After your pull request is merged, you can safely delete your branch and pull the changes
99+
from the main (upstream) repository:
100+
101+
* Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
102+
103+
```shell
104+
git push origin --delete my-fix-branch
105+
```
106+
107+
* Check out the master branch:
108+
109+
```shell
110+
git checkout master -f
111+
```
112+
113+
* Delete the local branch:
114+
115+
```shell
116+
git branch -D my-fix-branch
117+
```
118+
119+
* Update your master with the latest upstream version:
120+
121+
```shell
122+
git pull --ff upstream master
123+
```
124+
125+
126+
127+
128+
129+
<br>
130+
### Happy Coding :)

0 commit comments

Comments
 (0)