diff options
Diffstat (limited to 'docs/en/erlang.mk/1/guide/contributing/index.html')
| -rw-r--r-- | docs/en/erlang.mk/1/guide/contributing/index.html | 150 |
1 files changed, 38 insertions, 112 deletions
diff --git a/docs/en/erlang.mk/1/guide/contributing/index.html b/docs/en/erlang.mk/1/guide/contributing/index.html index 97a00e86..9ba72273 100644 --- a/docs/en/erlang.mk/1/guide/contributing/index.html +++ b/docs/en/erlang.mk/1/guide/contributing/index.html @@ -62,131 +62,57 @@ <h1 class="lined-header"><span>Contributing</span></h1> -<div class="paragraph"><p>You are welcome and encouraged to contribute.</p></div> -<div class="paragraph"><p>This is how.</p></div> -<div class="sect1"> +<p>You are welcome and encouraged to contribute.</p> +<p>This is how.</p> <h2 id="_priorities">Priorities</h2> -<div class="sectionbody"> -<div class="paragraph"><p>From the most important to the least important:</p></div> -<div class="ulist"><ul> -<li> -<p> -Bugs -</p> +<p>From the most important to the least important:</p> +<ul><li>Bugs </li> -<li> -<p> -Package issues/additions -</p> +<li>Package issues/additions </li> -<li> -<p> -Refactoring -</p> +<li>Refactoring </li> -<li> -<p> -Features -</p> +<li>Features </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_bugs">Bugs</h2> -<div class="sectionbody"> -<div class="paragraph"><p>If you have found a bug, you should open a ticket. Include -everything relevant including the command you used, output, -a link to the code that triggers the issue, why you think -this is a bug, etc.</p></div> -<div class="paragraph"><p>If you think you have found a bug but you are not sure, you -should open a ticket as previously explained.</p></div> -<div class="paragraph"><p>If you have found a bug and you need it to be solved RIGHT -NOW, open a ticket as previously explained.</p></div> -<div class="paragraph"><p>Once you have opened a ticket, be patient, try to answer -questions in a timely manner and confirm that the bug was -indeed fixed when it is.</p></div> -<div class="paragraph"><p>If you can’t be patient, either try to solve the bug and -contribute the fix back or become a paying customer.</p></div> -</div> -</div> -<div class="sect1"> +<p>If you have found a bug, you should open a ticket. Include everything relevant including the command you used, output, a link to the code that triggers the issue, why you think this is a bug, etc.</p> +<p>If you think you have found a bug but you are not sure, you should open a ticket as previously explained.</p> +<p>If you have found a bug and you need it to be solved RIGHT NOW, open a ticket as previously explained.</p> +<p>Once you have opened a ticket, be patient, try to answer questions in a timely manner and confirm that the bug was indeed fixed when it is.</p> +<p>If you can't be patient, either try to solve the bug and contribute the fix back or become a paying customer.</p> <h2 id="_code">Code</h2> -<div class="sectionbody"> -<div class="paragraph"><p>The code is located in the <em>core/*.mk</em> and <em>plugins/*.mk</em> files. -The tests are located in the <em>test/Makefile</em> and <em>test/*.mk</em> files.</p></div> -<div class="paragraph"><p>If you have a fix or a hack for a bug, you should open a -pull request. Any fix should include a test case that fails -before the fix and is working after.</p></div> -<div class="paragraph"><p>If you have a test case that reproduces a bug, but no fix for -it, you should open a pull request.</p></div> -<div class="paragraph"><p>Changes need to be tested with at least the <code>make check</code> -command. A specific test case can be tested using <code>make check c=CASE</code> -with <code>CASE</code> the name of the target to run. Output can be -modulated using the <code>V</code> variable, which is an integer -from 0 to 4. A typical use would be <code>make check c=dialyzer V=3</code>. -The value 4 is particular and shows expanded commands right -before they are executed.</p></div> -<div class="paragraph"><p>To run tests in parallel, use the <code>-j</code> option. It is generally -a good idea to also use the <code>-k</code> option to run all tests even -if one fails. For example: <code>make check -j 32 -k</code>.</p></div> -<div class="paragraph"><p>Some changes should be tested against all packages. Continue -reading for more details on testing them.</p></div> -</div> -</div> -<div class="sect1"> +<p>The code is located in the <em>core/\*.mk</em> and <em>plugins/\*.mk</em> files. The tests are located in the <em>test/Makefile</em> and <em>test/*.mk</em> files.</p> +<p>If you have a fix or a hack for a bug, you should open a pull request. Any fix should include a test case that fails before the fix and is working after.</p> +<p>If you have a test case that reproduces a bug, but no fix for it, you should open a pull request.</p> +<p>Changes need to be tested with at least the <code>make check</code> command. A specific test case can be tested using <code>make check c=CASE</code> with <code>CASE</code> the name of the target to run. Output can be modulated using the <code>V</code> variable, which is an integer from 0 to 4. A typical use would be <code>make check c=dialyzer V=3</code>. The value 4 is particular and shows expanded commands right before they are executed.</p> +<p>To run tests in parallel, use the <code>-j</code> option. It is generally a good idea to also use the <code>-k</code> option to run all tests even if one fails. For example: <code>make check -j 32 -k</code>.</p> +<p>Some changes should be tested against all packages. Continue reading for more details on testing them.</p> <h2 id="_packages">Packages</h2> -<div class="sectionbody"> -<div class="paragraph"><p>You can search existing packages using the <code>make search q=STRING</code> -command. This can be done both from an Erlang.mk project or -directly from the Erlang.mk repository.</p></div> -<div class="paragraph"><p>Packages can be added to the index using the <code>pkg_add.sh</code> script.</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<p>You can search existing packages using the <code>make search q=STRING</code> command. This can be done both from an Erlang.mk project or directly from the Erlang.mk repository.</p> +<p>Packages can be added to the index using the <code>pkg_add.sh</code> script.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -<pre><tt>$ git clone https<span style="color: #990000">:</span>//github<span style="color: #990000">.</span>com<span style="color: #990000">/</span><span style="color: #009900">$YOURUSERNAME</span>/erlang<span style="color: #990000">.</span>mk -$ cd erlang<span style="color: #990000">.</span>mk -$ <span style="color: #990000">.</span>/pkg_add<span style="color: #990000">.</span>sh cowboy git https<span style="color: #990000">:</span>//github<span style="color: #990000">.</span>com/ninenines/cowboy <span style="color: #993399">1.0</span><span style="color: #990000">.</span><span style="color: #993399">0</span> - http<span style="color: #990000">:</span>//ninenines<span style="color: #990000">.</span>eu <span style="color: #FF0000">"Small, fast and modular HTTP server."</span> -$ git push origin master</tt></pre></div></div> -<div class="paragraph"><p>Before sending a pull request, you should test your package. -You can use the following command: <code>make check p=PACKAGE</code>, -where <code>PACKAGE</code> is the name of the package, for example -<code>cowboy</code>.</p></div> -<div class="paragraph"><p>To test all packages, the <code>make packages</code> command can be used. -This can take a long time. Some packages will fail with certain -versions of Erlang, or if a prerequisite is missing from your system. -You can of course speed things up using the <code>-j</code> and <code>-k</code> flags.</p></div> -<div class="paragraph"><p>After all packages have been tested, you can run the command -<code>make summary</code> to know what changed since the previous run.</p></div> -</div> -</div> -<div class="sect1"> +<pre><tt>$ git clone https<font color="#990000">:</font>//github<font color="#990000">.</font>com<font color="#990000">/</font><font color="#009900">$YOURUSERNAME</font>/erlang<font color="#990000">.</font>mk +$ cd erlang<font color="#990000">.</font>mk +$ <font color="#990000">.</font>/pkg_add<font color="#990000">.</font>sh cowboy git https<font color="#990000">:</font>//github<font color="#990000">.</font>com/ninenines/cowboy <font color="#993399">1.0</font><font color="#990000">.</font><font color="#993399">0</font> + http<font color="#990000">:</font>//ninenines<font color="#990000">.</font>eu <font color="#FF0000">"Small, fast and modular HTTP server."</font> +$ git push origin master</tt></pre> +</div></div> +<p>Before sending a pull request, you should test your package. You can use the following command: <code>make check p=PACKAGE</code>, where <code>PACKAGE</code> is the name of the package, for example <code>cowboy</code>.</p> +<p>To test all packages, the <code>make packages</code> command can be used. This can take a long time. Some packages will fail with certain versions of Erlang, or if a prerequisite is missing from your system. You can of course speed things up using the <code>-j</code> and <code>-k</code> flags.</p> +<p>After all packages have been tested, you can run the command <code>make summary</code> to know what changed since the previous run.</p> <h2 id="_documentation">Documentation</h2> -<div class="sectionbody"> -<div class="paragraph"><p>The documentation is always right.</p></div> -<div class="paragraph"><p>If you think you have found a mistake in the documentation, -this is a bug. You can either open a ticket or send a pull -request.</p></div> -<div class="paragraph"><p>To make sure that the documentation changes work, install -the listed <a href="../asciidoc">Requirements</a> on your system and -run <code>make docs</code>.</p></div> -</div> -</div> -<div class="sect1"> +<p>The documentation is always right.</p> +<p>If you think you have found a mistake in the documentation, this is a bug. You can either open a ticket or send a pull request.</p> +<p>To make sure that the documentation changes work, install the listed <a href="../asciidoc">Requirements</a> on your system and run <code>make docs</code>.</p> <h2 id="_feature_requests">Feature requests</h2> -<div class="sectionbody"> -<div class="paragraph"><p>If you have an awesome idea or need something that Erlang.mk -doesn’t provide yet, open a ticket. Provide as much detail as -possible.</p></div> -<div class="paragraph"><p>If you have code, great! Open a pull request as previously -explained.</p></div> -<div class="paragraph"><p>If not, you can still improve your feature request by writing -the related documentation.</p></div> -</div> -</div> +<p>If you have an awesome idea or need something that Erlang.mk doesn't provide yet, open a ticket. Provide as much detail as possible.</p> +<p>If you have code, great! Open a pull request as previously explained.</p> +<p>If not, you can still improve your feature request by writing the related documentation.</p> + |