forked from django/django
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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 <[email protected]> Co-authored-by: Daniele Procida <[email protected]>
- Loading branch information
1 parent
4787972
commit 4eb4ab4
Showing
4 changed files
with
127 additions
and
87 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters