diff options
Diffstat (limited to 'topics/contributing.html')
| -rw-r--r-- | topics/contributing.html | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/topics/contributing.html b/topics/contributing.html index c9b1956c..6da9761c 100644 --- a/topics/contributing.html +++ b/topics/contributing.html @@ -206,7 +206,7 @@ <p>The most important thing you can do to help push the REST framework project forward is to be actively involved wherever possible. Code contributions are often overvalued as being the primary way to get involved in a project, we don't believe that needs to be the case.</p> <p>If you use REST framework, we'd love you to be vocal about your experiences with it - you might consider writing a blog post about using REST framework, or publishing a tutorial about building a project with a particular Javascript framework. Experiences from beginners can be particularly helpful because you'll be in the best position to assess which bits of REST framework are more difficult to understand and work with.</p> <p>Other really great ways you can help move the community forward include helping answer questions on the <a href="https://groups.google.com/forum/?fromgroups#!forum/django-rest-framework">discussion group</a>, or setting up an <a href="http://stackexchange.com/filters/66475/rest-framework">email alert on StackOverflow</a> so that you get notified of any new questions with the <code>django-rest-framework</code> tag.</p> -<p>When answering questions make sure to help future contributors find their way around by hyperlinking wherever possible to related threads and tickets, and include backlinks from those items if relevant. </p> +<p>When answering questions make sure to help future contributors find their way around by hyperlinking wherever possible to related threads and tickets, and include backlinks from those items if relevant.</p> <h2 id="code-of-conduct">Code of conduct</h2> <p>Please keep the tone polite & professional. For some users a discussion on the REST framework mailing list or ticket tracker may be their first engagement with the open source community. First impressions count, so let's try to make everyone feel welcome.</p> <p>Be mindful in the language you choose. As an example, in an environment that is heavily male-dominated, posts that start 'Hey guys,' can come across as unintentionally exclusive. It's just as easy, and more inclusive to use gender neutral language in those situations.</p> @@ -222,7 +222,7 @@ <li>Closing an issue doesn't necessarily mean the end of a discussion. If you believe your issue has been closed incorrectly, explain why and we'll consider if it needs to be reopened.</li> </ul> <h2 id="triaging-issues">Triaging issues</h2> -<p>Getting involved in triaging incoming issues is a good way to start contributing. Every single ticket that comes into the ticket tracker needs to be reviewed in order to determine what the next steps should be. Anyone can help out with this, you just need to be willing to </p> +<p>Getting involved in triaging incoming issues is a good way to start contributing. Every single ticket that comes into the ticket tracker needs to be reviewed in order to determine what the next steps should be. Anyone can help out with this, you just need to be willing to</p> <ul> <li>Read through the ticket - does it make sense, is it missing any context that would help explain it better?</li> <li>Is the ticket reported in the correct place, would it be better suited as a discussion on the discussion group?</li> @@ -246,7 +246,7 @@ pip install -r optionals.txt # Run the tests rest_framework/runtests/runtests.py </code></pre> -<p>You can also use the excellent <code>[tox][tox]</code> testing tool to run the tests against all supported versions of Python and Django. Install <code>tox</code> globally, and then simply run:</p> +<p>You can also use the excellent <a href="http://tox.readthedocs.org/en/latest/">tox</a> testing tool to run the tests against all supported versions of Python and Django. Install <code>tox</code> globally, and then simply run:</p> <pre class="prettyprint lang-py"><code>tox </code></pre> <h2 id="pull-requests">Pull requests</h2> @@ -285,7 +285,7 @@ rest_framework/runtests/runtests.py <p>Headers should use the hash style. For example:</p> <pre class="prettyprint lang-py"><code>### Some important topic </code></pre> -<p>The underline style should not be used. <strong>Don't do this:</strong> </p> +<p>The underline style should not be used. <strong>Don't do this:</strong></p> <pre class="prettyprint lang-py"><code>Some important topic ==================== </code></pre> |