summaryrefslogtreecommitdiff
path: root/docs/internals/contributing/writing-code
diff options
context:
space:
mode:
authorMark Walker <mark@marksweb.co.uk>2023-12-01 00:43:56 +0000
committerNatalia <124304+nessita@users.noreply.github.com>2024-01-11 22:25:27 -0300
commit4eb4ab4122b2b974911d4b1f935728cf35e4208c (patch)
tree0a8426a1dc924aaca6b90fcfb17e39a859047ec5 /docs/internals/contributing/writing-code
parent4787972c941b0d090cf083e84a98c1791bb2ae4b (diff)
Reorganized the Contributing to Django docs.
This work follows a comprehensive review conducted during the DjangoCon US 2023 sprints. Changes include: - Updated the title of the main page for better alignment with the content. - Removed emojis to enhance accessibility and avoid cultural specificity. - Improved the layout and navigation of contributing documentation. - Unified sections for communication channels and community links. - Grouped resources according to the Diátaxis systematic approach. Co-authored-by: Natalia <124304+nessita@users.noreply.github.com> Co-authored-by: Daniele Procida <daniele@vurt.org>
Diffstat (limited to 'docs/internals/contributing/writing-code')
-rw-r--r--docs/internals/contributing/writing-code/index.txt62
-rw-r--r--docs/internals/contributing/writing-code/javascript.txt6
2 files changed, 38 insertions, 30 deletions
diff --git a/docs/internals/contributing/writing-code/index.txt b/docs/internals/contributing/writing-code/index.txt
index 9402c26808..72cc264524 100644
--- a/docs/internals/contributing/writing-code/index.txt
+++ b/docs/internals/contributing/writing-code/index.txt
@@ -1,43 +1,51 @@
-============
-Writing code
-============
+=================
+Contributing code
+=================
-So you'd like to write some code to improve Django? Awesome! There are several
-ways you can help Django's development:
+So you'd like to write some code, documentation or tests to improve Django?
+There are several ways you can help Django's development.
-* :doc:`Report bugs <../bugs-and-features>` in our `ticket tracker`_.
+Tutorials
+=========
-* Join the |django-developers| mailing list and share your ideas for how to
- improve Django. We're always open to suggestions. You can also interact on
- the `Django forum`_ and the `#django-dev IRC channel`_.
+The Django tutorial contains a whole section that walks you step-by-step
+through the contributing code process.
-* :doc:`Submit patches <submitting-patches>` for new and/or fixed behavior. If
- you're looking for a way to get started contributing to Django read the
- :doc:`/intro/contributing` tutorial and have a look at the `easy pickings`_
- tickets. The :ref:`patch-review-checklist` will also be helpful.
+.. toctree::
+ :maxdepth: 1
+
+ /intro/contributing
-* :doc:`Improve the documentation <../writing-documentation>` or :doc:`write
- unit tests <unit-tests>`.
+How-to guides
+=============
-* :doc:`Triage tickets and review patches <../triaging-tickets>` created by
- other users.
+If you already have some familiarity with the processes and principles,
+our documentation also contains useful guidance on specific topics:
-* Read the :doc:`../new-contributors` to help you get orientated in the
- development process.
+.. toctree::
+ :maxdepth: 1
-Browse the following sections to find out how to give your code patches the
-best chances to be included in Django core:
+ How to submit a patch to Django for new and/or fixed behavior <submitting-patches>
+ How to write and run tests </topics/testing/overview>
+ How to run Django's unit tests <unit-tests>
+ How to work with Git and GitHub <working-with-git>
+
+Related topics
+==============
+
+It's important to understand how we work and the conventions we adopt.
.. toctree::
:maxdepth: 1
coding-style
- unit-tests
- submitting-patches
- working-with-git
javascript
+ ../committing-code
+
+We maintain a curated list of small issues suited to first-time or less
+experienced contributors, using the "easy pickings" filter. These are strongly
+recommended for those contributors looking to make a contribution.
+
+* Browse `easy pickings`_ tickets.
-.. _ticket tracker: https://code.djangoproject.com/
.. _easy pickings: https://code.djangoproject.com/query?status=!closed&easy=1
-.. _#django-dev IRC channel: https://web.libera.chat/#django-dev
-.. _Django forum: https://forum.djangoproject.com/
diff --git a/docs/internals/contributing/writing-code/javascript.txt b/docs/internals/contributing/writing-code/javascript.txt
index 657cc66ded..25165206f0 100644
--- a/docs/internals/contributing/writing-code/javascript.txt
+++ b/docs/internals/contributing/writing-code/javascript.txt
@@ -1,6 +1,6 @@
-==========
-JavaScript
-==========
+===============
+JavaScript code
+===============
While most of Django core is Python, the ``admin`` and ``gis`` contrib apps
contain JavaScript code.