You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6
+
7
+
## Our Standards
8
+
9
+
Examples of behavior that contributes to creating a positive environment include:
10
+
11
+
* Using welcoming and inclusive language
12
+
* Being respectful of differing viewpoints and experiences
13
+
* Gracefully accepting constructive criticism
14
+
* Focusing on what is best for the community
15
+
* Showing empathy towards other community members
16
+
17
+
Examples of unacceptable behavior by participants include:
18
+
19
+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20
+
* Trolling, insulting/derogatory comments, and personal or political attacks
21
+
* Public or private harassment
22
+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
23
+
* Other conduct which could reasonably be considered inappropriate in a professional setting
24
+
25
+
## Our Responsibilities
26
+
27
+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28
+
29
+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30
+
31
+
## Scope
32
+
33
+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34
+
35
+
## Enforcement
36
+
37
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at mahmoud@zalt.me. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38
+
39
+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40
+
41
+
## Attribution
42
+
43
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
Copy file name to clipboardExpand all lines: DOCUMENTATION/content/contributing/index.md
+60-23Lines changed: 60 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,15 +5,16 @@ weight: 7
5
5
---
6
6
7
7
8
-
Your contribution is more than welcome.
9
-
10
-
## I have a Question/Problem
8
+
## Have a Question
11
9
12
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 believe your question could help others, then consider opening an [Issue](https://github.com/laradock/laradock/issues) (it will be labeled as `Question`) And you can still seek help on Gitter for it.
13
11
14
-
## I found an Issue
12
+
13
+
14
+
## Found an Issue
15
+
15
16
If have an issue or you found a typo in the documentation, you can help us by
16
-
opnening an [Issue](https://github.com/laradock/laradock/issues).
17
+
opening an [Issue](https://github.com/laradock/laradock/issues).
17
18
18
19
**Steps to do before opening an Issue:**
19
20
@@ -23,18 +24,18 @@ opnening an [Issue](https://github.com/laradock/laradock/issues).
23
24
24
25
If your issue appears to be a bug, and hasn't been reported, then open a new issue.
25
26
26
-
*This Help us to maximize the effort we can spend fixing issues and adding new
27
+
*This helps us maximize the effort we can spend fixing issues and adding new
27
28
features, by not reporting duplicate issues.*
28
29
29
30
30
-
## I want a Feature
31
-
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 yourself.
32
31
32
+
## Want a Feature
33
+
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 yourself.
33
34
34
35
35
36
36
37
37
-
## I want to update the Documentation (Site)
38
+
## Update the Documentation (Site)
38
39
39
40
Laradock uses [Hugo](https://gohugo.io/) as website generator tool, with the [Material Docs theme](http://themes.gohugo.io/theme/material-docs/). You might need to check their docs quickly.
40
41
@@ -47,9 +48,8 @@ To update the sidebar or add a new section to it, you can edit this `DOCUMENTATI
47
48
> The site will be auto-generated in the `docs/` folder by [Travis CI](https://travis-ci.org/laradock/laradock/).
48
49
49
50
50
-
<br>
51
51
52
-
### To Host the website locally
52
+
### Host the documentation locally
53
53
54
54
1. Install [Hugo](https://gohugo.io/) on your machine.
55
55
2. Edit the `DOCUMENTATION/content`.
@@ -59,33 +59,70 @@ To update the sidebar or add a new section to it, you can edit this `DOCUMENTATI
59
59
60
60
61
61
62
-
## How to support new Software (Add new Container)
62
+
## Support new Software (Add new Container)
63
63
64
-
*Create folder with the software name.
64
+
*Fork the repo and clone the code.
65
65
66
-
*Add a `Dockerfile`, write your code there.
66
+
*Create folder as the software name (example: `mysql` - `nginx`).
67
67
68
-
*You may add additional files in the software folder.
68
+
*Add your `Dockerfile` in the folder "you may add additional files as well".
69
69
70
70
* Add the software to the `docker-compose.yml` file.
71
71
72
-
* Make sure you follow our commenting style.
72
+
* Make sure you follow the same code/comments style.
73
+
74
+
* Add the environment variables to the `env-example` if you have any.
75
+
76
+
***MOST IMPORTANTLY** updated the `Documentation`, add as much information.
73
77
74
-
*Add the software in the `Documentation`.
78
+
*Submit a Pull Request, to the `master` branch.
75
79
76
-
## Edit existing Software (Edit a Container)
77
80
78
-
* Open the software (container) folder.
79
81
80
-
* Edit the files you want to update.
82
+
##Edit supported Software (Edit a Container)
81
83
82
-
***Note:** If you want to edit the base image of the `Workspace` or the `php-fpm` Containers,
83
-
you need to edit their Docker-files from their GitHub repositories. For more info read their Dockerfiles comment on the Laradock repository.
84
+
* Fork the repo and clone the code.
85
+
86
+
* Open the software (container) folder (example: `mysql` - `nginx`).
87
+
88
+
* Edit the files.
84
89
85
90
* Make sure to update the `Documentation` in case you made any changes.
86
91
92
+
* Submit a Pull Request, to the `master` branch.
93
+
94
+
95
+
96
+
97
+
## Edit Base Image
98
+
99
+
* Open any dockerfile, copy the base image name (example: `FROM phusion/baseimage:latest`).
100
+
101
+
* Search for the image in the [Docker Hub](https://hub.docker.com/search/) and find the source..
102
+
103
+
*Most of the image in Laradock are offical images, these projects live in other repositories and maintainer by other orgnizations.*
104
+
105
+
**Note:** Laradock has two base images for (`Workspace` and `php-fpm`, mainly made to speed up the build time on your machine.
106
+
107
+
* Find the dockerfiles, edit them and submit a Pull Request.
108
+
109
+
* When updating a Laradock base image (`Workspace` or `php-fpm`), ask a project maintainer "Admin" to build a new image after your PR is merged.
110
+
111
+
**Note:** after the base image is updated, every dockerfile that uses that image, needs to update his base image tag to get the updated code.
0 commit comments