laradock/docs/contributing/index.xml

<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
  <channel>
    <title>Contributings on Laradock</title>
    <link>http://laradock.io/contributing/index.xml</link>
    <description>Recent content in Contributings on Laradock</description>
    <generator>Hugo -- gohugo.io</generator>
    <language>en-us</language>
    <atom:link href="http://laradock.io/contributing/index.xml" rel="self" type="application/rss+xml" />
    
    <item>
      <title>Contributing</title>
      <link>http://laradock.io/contributing/</link>
      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
      
      <guid>http://laradock.io/contributing/</guid>
      <description>

&lt;p&gt;Your contribution is more than welcome.&lt;/p&gt;

&lt;h2 id=&#34;i-have-a-question-problem&#34;&gt;I have a Question/Problem&lt;/h2&gt;

&lt;p&gt;If you have questions about how to use Laradock, please direct your questions to the discussion on &lt;a href=&#34;https://gitter.im/Laradock/laradock&#34;&gt;Gitter&lt;/a&gt;. If you believe your question could help others, then consider opening an &lt;a href=&#34;https://github.com/laradock/laradock/issues&#34;&gt;Issue&lt;/a&gt; (it will be labeled as &lt;code&gt;Question&lt;/code&gt;) And you can still seek help on Gitter for it.&lt;/p&gt;

&lt;h2 id=&#34;i-found-an-issue&#34;&gt;I found an Issue&lt;/h2&gt;

&lt;p&gt;If have an issue or you found a typo in the documentation, you can help us by
opnening an &lt;a href=&#34;https://github.com/laradock/laradock/issues&#34;&gt;Issue&lt;/a&gt;.&lt;/p&gt;

&lt;p&gt;&lt;strong&gt;Steps to do before opening an Issue:&lt;/strong&gt;&lt;/p&gt;

&lt;ol&gt;
&lt;li&gt;&lt;p&gt;Before you submit your issue search the archive, maybe your question was already answered couple hours ago (search in the closed Issues as well).&lt;/p&gt;&lt;/li&gt;

&lt;li&gt;&lt;p&gt;Decide if the Issue belongs to this project or to &lt;a href=&#34;https://github.com/docker&#34;&gt;Docker&lt;/a&gt; itself! or even the tool you are using such as Nginx or MongoDB&amp;hellip;&lt;/p&gt;&lt;/li&gt;
&lt;/ol&gt;

&lt;p&gt;If your issue appears to be a bug, and hasn&amp;rsquo;t been reported, then open a new issue.&lt;/p&gt;

&lt;p&gt;&lt;em&gt;This Help us to maximize the effort we can spend fixing issues and adding new
features, by not reporting duplicate issues.&lt;/em&gt;&lt;/p&gt;

&lt;h2 id=&#34;i-want-a-feature&#34;&gt;I want a Feature&lt;/h2&gt;

&lt;p&gt;You can request a new feature by submitting an &lt;a href=&#34;https://github.com/laradock/laradock/issues&#34;&gt;Issue&lt;/a&gt; (it will be labeled as &lt;code&gt;Feature Suggestion&lt;/code&gt;). If you would like to implement a new feature then consider submitting a Pull Request yourself.&lt;/p&gt;

&lt;h2 id=&#34;i-want-to-update-the-documentation-site&#34;&gt;I want to update the Documentation (Site)&lt;/h2&gt;

&lt;p&gt;Laradock uses &lt;a href=&#34;https://gohugo.io/&#34;&gt;Hugo&lt;/a&gt; as website generator tool, with the &lt;a href=&#34;http://themes.gohugo.io/theme/material-docs/&#34;&gt;Material Docs theme&lt;/a&gt;. You might need to check their docs quickly.&lt;/p&gt;

&lt;p&gt;Go the &lt;code&gt;DOCUMENTATION/content&lt;/code&gt; and search for the markdown file you want to edit&lt;/p&gt;

&lt;p&gt;Note: Every folder represents a section in the sidebar &amp;ldquo;Menu&amp;rdquo;. And every page and sidebar has a &lt;code&gt;weight&lt;/code&gt; number to show it&amp;rsquo;s position in the site.&lt;/p&gt;

&lt;p&gt;To update the sidebar or add a new section to it, you can edit this &lt;code&gt;DOCUMENTATION/config.toml&lt;/code&gt; toml file.&lt;/p&gt;

&lt;blockquote&gt;
&lt;p&gt;The site will be auto-generated in the &lt;code&gt;docs/&lt;/code&gt; folder by &lt;a href=&#34;https://travis-ci.org/laradock/laradock/&#34;&gt;Travis CI&lt;/a&gt;.&lt;/p&gt;
&lt;/blockquote&gt;

&lt;p&gt;&lt;br&gt;&lt;/p&gt;

&lt;h3 id=&#34;to-host-the-website-locally&#34;&gt;To Host the website locally&lt;/h3&gt;

&lt;ol&gt;
&lt;li&gt;Install &lt;a href=&#34;https://gohugo.io/&#34;&gt;Hugo&lt;/a&gt; on your machine.&lt;/li&gt;
&lt;li&gt;Edit the &lt;code&gt;DOCUMENTATION/content&lt;/code&gt;.&lt;/li&gt;
&lt;li&gt;Delete the &lt;code&gt;/docs&lt;/code&gt; folder from the root.&lt;/li&gt;
&lt;li&gt;After you finish the editing, go to &lt;code&gt;DOCUMENTATION/&lt;/code&gt; and run the &lt;code&gt;hugo&lt;/code&gt; command to generate the HTML docs (inside a new &lt;code&gt;/docs&lt;/code&gt; folder).&lt;/li&gt;
&lt;/ol&gt;

&lt;h2 id=&#34;how-to-support-new-software-add-new-container&#34;&gt;How to support new Software (Add new Container)&lt;/h2&gt;

&lt;ul&gt;
&lt;li&gt;&lt;p&gt;Create folder with the software name.&lt;/p&gt;&lt;/li&gt;

&lt;li&gt;&lt;p&gt;Add a &lt;code&gt;Dockerfile&lt;/code&gt;, write your code there.&lt;/p&gt;&lt;/li&gt;

&lt;li&gt;&lt;p&gt;You may add additional files in the software folder.&lt;/p&gt;&lt;/li&gt;

&lt;li&gt;&lt;p&gt;Add the software to the &lt;code&gt;docker-compose.yml&lt;/code&gt; file.&lt;/p&gt;&lt;/li&gt;

&lt;li&gt;&lt;p&gt;Make sure you follow our commenting style.&lt;/p&gt;&lt;/li&gt;

&lt;li&gt;&lt;p&gt;Add the software in the &lt;code&gt;Documentation&lt;/code&gt;.&lt;/p&gt;&lt;/li&gt;
&lt;/ul&gt;

&lt;h2 id=&#34;edit-existing-software-edit-a-container&#34;&gt;Edit existing Software (Edit a Container)&lt;/h2&gt;

&lt;ul&gt;
&lt;li&gt;&lt;p&gt;Open the software (container) folder.&lt;/p&gt;&lt;/li&gt;

&lt;li&gt;&lt;p&gt;Edit the files you want to update.&lt;/p&gt;&lt;/li&gt;

&lt;li&gt;&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt; If you want to edit the base image of the &lt;code&gt;Workspace&lt;/code&gt; or the &lt;code&gt;php-fpm&lt;/code&gt; Containers,
you need to edit their Docker-files from their GitHub repositories. For more info read their Dockerfiles comment on the Laradock repository.&lt;/p&gt;&lt;/li&gt;

&lt;li&gt;&lt;p&gt;Make sure to update the &lt;code&gt;Documentation&lt;/code&gt; in case you made any changes.&lt;/p&gt;&lt;/li&gt;
&lt;/ul&gt;

&lt;h2 id=&#34;pull-request&#34;&gt;Pull Request&lt;/h2&gt;

&lt;h3 id=&#34;1-before-submitting-a-pull-request-pr&#34;&gt;1. Before Submitting a Pull Request (PR)&lt;/h3&gt;

&lt;p&gt;Always Test everything and make sure its working:&lt;/p&gt;

&lt;ul&gt;
&lt;li&gt;Pull the latest updates (or fork of you don’t have permission)&lt;/li&gt;
&lt;li&gt;Before editing anything:

&lt;ul&gt;
&lt;li&gt;Test building the container (docker-compose build &amp;ndash;no-cache container-name) build with no cache first.&lt;/li&gt;
&lt;li&gt;Test running the container with some other containers in real app and see of everything is working fine.&lt;/li&gt;
&lt;/ul&gt;&lt;/li&gt;
&lt;li&gt;Now edit the container (edit section by section and test rebuilding the container after every edited section)

&lt;ul&gt;
&lt;li&gt;Testing building the container (docker-compose build container-name) with no errors.&lt;/li&gt;
&lt;li&gt;Test it in a real App if possible.&lt;/li&gt;
&lt;/ul&gt;&lt;/li&gt;
&lt;/ul&gt;

&lt;h3 id=&#34;2-submitting-a-pr&#34;&gt;2. Submitting a PR&lt;/h3&gt;

&lt;p&gt;Consider the following guidelines:&lt;/p&gt;

&lt;ul&gt;
&lt;li&gt;&lt;p&gt;Search &lt;a href=&#34;https://github.com/laradock/laradock/pulls&#34;&gt;GitHub&lt;/a&gt; for an open or closed Pull Request that relates to your submission. You don&amp;rsquo;t want to duplicate efforts.&lt;/p&gt;&lt;/li&gt;

&lt;li&gt;&lt;p&gt;Make your changes in a new git branch:&lt;/p&gt;

&lt;pre&gt;&lt;code class=&#34;language-shell&#34;&gt; git checkout -b my-fix-branch master
&lt;/code&gt;&lt;/pre&gt;&lt;/li&gt;

&lt;li&gt;&lt;p&gt;Commit your changes using a descriptive commit message.&lt;/p&gt;&lt;/li&gt;

&lt;li&gt;&lt;p&gt;Push your branch to GitHub:&lt;/p&gt;

&lt;pre&gt;&lt;code class=&#34;language-shell&#34;&gt;git push origin my-fix-branch
&lt;/code&gt;&lt;/pre&gt;&lt;/li&gt;

&lt;li&gt;&lt;p&gt;In GitHub, send a pull request to &lt;code&gt;laradock:master&lt;/code&gt;.&lt;/p&gt;&lt;/li&gt;

&lt;li&gt;&lt;p&gt;If we suggest changes then:&lt;/p&gt;

&lt;ul&gt;
&lt;li&gt;Make the required updates.&lt;/li&gt;
&lt;li&gt;Commit your changes to your branch (e.g. &lt;code&gt;my-fix-branch&lt;/code&gt;).&lt;/li&gt;
&lt;li&gt;Push the changes to your GitHub repository (this will update your Pull Request).&lt;/li&gt;
&lt;/ul&gt;&lt;/li&gt;
&lt;/ul&gt;

&lt;blockquote&gt;
&lt;p&gt;If the PR gets too outdated we may ask you to rebase and force push to update the PR:&lt;/p&gt;
&lt;/blockquote&gt;

&lt;pre&gt;&lt;code class=&#34;language-shell&#34;&gt;git rebase master -i
git push origin my-fix-branch -f
&lt;/code&gt;&lt;/pre&gt;

&lt;p&gt;&lt;em&gt;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.&lt;/em&gt;&lt;/p&gt;

&lt;h3 id=&#34;3-after-your-pr-is-merged&#34;&gt;3. After your PR is merged&lt;/h3&gt;

&lt;p&gt;After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:&lt;/p&gt;

&lt;ul&gt;
&lt;li&gt;&lt;p&gt;Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:&lt;/p&gt;

&lt;pre&gt;&lt;code class=&#34;language-shell&#34;&gt;git push origin --delete my-fix-branch
&lt;/code&gt;&lt;/pre&gt;&lt;/li&gt;

&lt;li&gt;&lt;p&gt;Check out the master branch:&lt;/p&gt;

&lt;pre&gt;&lt;code class=&#34;language-shell&#34;&gt;git checkout master -f
&lt;/code&gt;&lt;/pre&gt;&lt;/li&gt;

&lt;li&gt;&lt;p&gt;Delete the local branch:&lt;/p&gt;

&lt;pre&gt;&lt;code class=&#34;language-shell&#34;&gt;git branch -D my-fix-branch
&lt;/code&gt;&lt;/pre&gt;&lt;/li&gt;

&lt;li&gt;&lt;p&gt;Update your master with the latest upstream version:&lt;/p&gt;

&lt;pre&gt;&lt;code class=&#34;language-shell&#34;&gt;git pull --ff upstream master
&lt;/code&gt;&lt;/pre&gt;&lt;/li&gt;
&lt;/ul&gt;

&lt;p&gt;&lt;br&gt;&lt;/p&gt;

&lt;h4 id=&#34;happy-coding&#34;&gt;Happy Coding :)&lt;/h4&gt;
</description>
    </item>
    
  </channel>
</rss>