mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-08-30 07:17:49 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Reorganized the Contributing to Django docs.

Browse source 
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>
This commit is contained in:
Mark Walker 2023-12-01 00:43:56 +00:00 • committed by Natalia
parent 4787972c94
commit 4eb4ab4122
4 changed files with 128 additions and 88 deletions
Download patch file Download diff file Expand all files Collapse all files

62
docs/internals/contributing/writing-code/index.txt
View file

@ -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
* :doc:`Improve the documentation <../writing-documentation>` or :doc:`write
unit tests <unit-tests>`.
/intro/contributing
* :doc:`Triage tickets and review patches <../triaging-tickets>` created by
other users.
How-to guides
=============
* Read the :doc:`../new-contributors` to help you get orientated in the
development process.
If you already have some familiarity with the processes and principles,
our documentation also contains useful guidance on specific topics:
Browse the following sections to find out how to give your code patches the
best chances to be included in Django core:
.. toctree::
:maxdepth: 1
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/

6
docs/internals/contributing/writing-code/javascript.txt
View file

@ -1,6 +1,6 @@
==========
JavaScript
==========
===============
JavaScript code
===============
While most of Django core is Python, the ``admin`` and ``gis`` contrib apps
contain JavaScript code.