Contributings on Laradock Docs http://laradock.io/contributing/index.xml Recent content in Contributings on Laradock Docs Hugo -- gohugo.io en-us Contributing http://laradock.io/contributing/ Mon, 01 Jan 0001 00:00:00 +0000 http://laradock.io/contributing/ <p>Your contribution is more than welcome.</p> <h2 id="got-a-question-or-problem">Got a Question or Problem?</h2> <p>If you have questions about how to use LaraDock, please direct your questions to the discussion on <a href="https://gitter.im/LaraDock/laradock">Gitter</a>. If you believe your question could help others, then consider opening an <a href="https://github.com/laradock/laradock/issues">Issue</a> (it will be labeled as Question).</p> <h2 id="found-an-issue">Found an Issue?</h2> <p>If you find a bug in the source code or a mistake in the documentation, you can help us by submitting an <a href="https://github.com/laradock/laradock/issues">Issue</a>. Even better you can submit a Pull Request with a fix.</p> <h2 id="want-a-feature">Want a Feature?</h2> <p>You can request a new feature by submitting an <a href="https://github.com/laradock/laradock/issues">Issue</a> (it will be labeled as Feature Suggestion). If you would like to implement a new feature then consider submitting a Pull Request.</p> <h2 id="edit-the-documentation">Edit the documentation</h2> <p>Laradock uses <a href="https://gohugo.io/">Hugo</a> as website generator tool, with the <a href="http://themes.gohugo.io/theme/material-docs/">Material Docs theme</a>. You might need to check their docs quickly.</p> <ol> <li>Install <a href="https://gohugo.io/">Hugo</a> on your machine.</li> <li>Clone laradock.</li> <li>Go to <code>/docs</code>.</li> <li>Delete everything except the <code>_settings</code> folder &amp; the <code>CNAME</code> file.</li> <li>Open <code>docs/_settings</code> from your terminal and run <code>hugo serve</code> to host the website locally.</li> <li>Open the <code>docs/_settings/content</code> and search for the folder of the section you want to edit.</li> <li>In each secion there&rsquo;s an <code>index.md</code> file, that&rsquo;s the file you need to edit.</li> <li>To edit the sidebar (in case you are adding new section) go to <code>docs/_settings/config.toml</code> and add the section there.</li> <li>After done editing, run the this command <code>hugo</code> to generate the updated site inside the <code>docs</code> folder.</li> <li>Go back to the project root directory, commit and push..</li> </ol> <h2 id="coding-guidelines">Coding Guidelines</h2> <h2 id="support-new-software">Support new Software</h2> <ul> <li><p>Create folder with the software name.</p></li> <li><p>Add a <code>Dockerfile</code>, write your code there.</p></li> <li><p>You may add additional files in the software folder.</p></li> <li><p>Add the software to the <code>docker-compose.yml</code> file.</p></li> <li><p>Make sure you follow our commenting style.</p></li> <li><p>Add the software in the <code>Readme</code>.</p></li> </ul> <h2 id="edit-existing-software">Edit existing Software</h2> <ul> <li><p>Open the software (container) folder.</p></li> <li><p>Edit the files you want to update.</p></li> <li><p><strong>Note:</strong> If you want to edit the base image of the <code>Workspace</code> or the <code>php-fpm</code> Containers, you need to edit their Dockerfiles from their GitHub repositories. For more info read their Dockerfiles comment on the LaraDock repository.</p></li> <li><p>Make sure to update the <code>Readme</code> in case you made any changes.</p></li> </ul> <h2 id="issue-pr-submission-guidelines">Issue/PR Submission Guidelines</h2> <h2 id="submitting-an-issue">Submitting an Issue</h2> <p>Before you submit your issue search the archive, maybe your question was already answered.</p> <p>If your issue appears to be a bug, and hasn&rsquo;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.</p> <h2 id="before-submitting-a-pull-request-pr">Before Submitting a Pull Request (PR)</h2> <p>Always Test everything and make sure its working:</p> <ul> <li>Pull the latest updates (or fork of you don’t have permission)</li> <li>Before editing anything: <ul> <li>Test building the container (docker-compose build &ndash;no-cache container-name) build with no cache first.</li> <li>Test running the container with some other containers in real app and see of everything is working fine.</li> </ul></li> <li>Now edit the container (edit section by section and test rebuilding the container after every edited section) <ul> <li>Testing building the container (docker-compose build container-name) with no errors.</li> <li>Test it in real App.</li> </ul></li> </ul> <h2 id="submitting-a-pr">Submitting a PR</h2> <p>Consider the following guidelines:</p> <ul> <li><p>Search <a href="https://github.com/laradock/laradock/pulls">GitHub</a> for an open or closed Pull Request that relates to your submission. You don&rsquo;t want to duplicate effort.</p></li> <li><p>Make your changes in a new git branch:</p> <pre><code class="language-shell"> git checkout -b my-fix-branch master </code></pre></li> <li><p>Commit your changes using a descriptive commit message.</p></li> <li><p>Push your branch to GitHub:</p> <pre><code class="language-shell">git push origin my-fix-branch </code></pre></li> <li><p>In GitHub, send a pull request to <code>laradock:master</code>.</p></li> <li><p>If we suggest changes then:</p> <ul> <li>Make the required updates.</li> <li>Commit your changes to your branch (e.g. <code>my-fix-branch</code>).</li> <li>Push the changes to your GitHub repository (this will update your Pull Request).</li> </ul></li> </ul> <blockquote> <p>If the PR gets too outdated we may ask you to rebase and force push to update the PR:</p> </blockquote> <pre><code class="language-shell">git rebase master -i git push origin my-fix-branch -f </code></pre> <p><em>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.</em></p> <h2 id="after-your-pr-is-merged">After your PR is merged</h2> <p>After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:</p> <ul> <li><p>Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:</p> <pre><code class="language-shell">git push origin --delete my-fix-branch </code></pre></li> <li><p>Check out the master branch:</p> <pre><code class="language-shell">git checkout master -f </code></pre></li> <li><p>Delete the local branch:</p> <pre><code class="language-shell">git branch -D my-fix-branch </code></pre></li> <li><p>Update your master with the latest upstream version:</p> <pre><code class="language-shell">git pull --ff upstream master </code></pre></li> </ul> <p><br></p> <h2 id="happy-coding">Happy Coding :)</h2>