Django/django
11
0
Fork 0
Code Pull Requests Projects Releases Activity

[4.2.x] Fixed #34579 -- Added Django Forum to contributing guides.

Browse Source 
Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>

Backport of 89f10a80d7e681cd0cccf22d932e380f51bd3524 from main
This commit is contained in:
Mohit Singh Sinsniwal 2023-05-20 04:55:41 +05:30 committed by Mariusz Felisiak
parent 37ba4c3a94
commit b4563cdd23
6 changed files with 44 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/internals/contributing/bugs-and-features.txt
View File

@ -20,11 +20,11 @@ Otherwise, before reporting a bug or requesting a new feature on the
|django-users| list or the `#django`_ IRC channel for that. |django-users| list or the `#django`_ IRC channel for that.
* Don't reopen issues that have been marked "wontfix" without finding consensus * Don't reopen issues that have been marked "wontfix" without finding consensus
to do so on |django-developers|. to do so on the `Django Forum`_ or |django-developers| list.
* Don't use the ticket tracker for lengthy discussions, because they're * Don't use the ticket tracker for lengthy discussions, because they're
likely to get lost. If a particular ticket is controversial, please move the likely to get lost. If a particular ticket is controversial, please move the
discussion to |django-developers|. discussion to the `Django Forum`_ or |django-developers| list.
.. _reporting-bugs: .. _reporting-bugs:
@ -94,11 +94,10 @@ part of that. Here are some tips on how to make a request most effectively:
suggest that you develop it independently. Then, if your project gathers suggest that you develop it independently. Then, if your project gathers
sufficient community support, we may consider it for inclusion in Django. sufficient community support, we may consider it for inclusion in Django.
* First request the feature on the |django-developers| list, not in the * First request the feature on the `Django Forum`_ or |django-developers| list,
ticket tracker. It'll get read more closely if it's on the mailing list. not in the ticket tracker. It'll get read more closely if it's on the mailing
This is even more important for large-scale feature requests. We like to list. This is even more important for large-scale feature requests. We like
discuss any big changes to Django's core on the mailing list before to discuss any big changes to Django's core before actually working on them.
actually working on them.
* Describe clearly and concisely what the missing feature is and how you'd * Describe clearly and concisely what the missing feature is and how you'd
like to see it implemented. Include example code (non-functional is OK) like to see it implemented. Include example code (non-functional is OK)
@ -109,8 +108,7 @@ part of that. Here are some tips on how to make a request most effectively:
achieving the same thing. achieving the same thing.
If there's a consensus agreement on the feature, then it's appropriate to If there's a consensus agreement on the feature, then it's appropriate to
create a ticket. Include a link to the discussion on |django-developers| in the create a ticket. Include a link to the discussion in the ticket description.
ticket description.
As with most open-source projects, code talks. If you are willing to write the As with most open-source projects, code talks. If you are willing to write the
code for the feature yourself or, even better, if you've already written it, code for the feature yourself or, even better, if you've already written it,
@ -160,8 +158,9 @@ Since this process allows any steering council member to veto a proposal, a
convert that "-1" into at least a "+0". convert that "-1" into at least a "+0".
Votes on technical matters should be announced and held in public on the Votes on technical matters should be announced and held in public on the
|django-developers| mailing list or on the Django Forum. |django-developers| mailing list or on the `Django Forum`_.
.. _searching: https://code.djangoproject.com/search .. _searching: https://code.djangoproject.com/search
.. _custom queries: https://code.djangoproject.com/query .. _custom queries: https://code.djangoproject.com/query
.. _#django: https://web.libera.chat/#django .. _#django: https://web.libera.chat/#django
.. _Django Forum: https://forum.djangoproject.com/

23
docs/internals/contributing/committing-code.txt
View File

@ -109,14 +109,14 @@ Django's Git repository:
discuss the situation with the team. discuss the situation with the team.
* For any medium-to-big changes, where "medium-to-big" is according to * For any medium-to-big changes, where "medium-to-big" is according to
your judgment, please bring things up on the |django-developers| your judgment, please bring things up on the `Django Forum`_ or
mailing list before making the change. |django-developers| mailing list before making the change.
If you bring something up on |django-developers| and nobody responds, If you bring something up and nobody responds, please don't take that
please don't take that to mean your idea is great and should be to mean your idea is great and should be implemented immediately because
implemented immediately because nobody contested it. Everyone doesn't always nobody contested it. Everyone doesn't always have a lot of time to read
have a lot of time to read mailing list discussions immediately, so you may mailing list discussions immediately, so you may have to wait a couple of
have to wait a couple of days before getting a response. days before getting a response.
* Write detailed commit messages in the past tense, not present tense. * Write detailed commit messages in the past tense, not present tense.
@ -227,15 +227,15 @@ When a mistaken commit is discovered, please follow these guidelines:
* If the original author can't be reached (within a reasonable amount * If the original author can't be reached (within a reasonable amount
of time -- a day or so) and the problem is severe -- crashing bug, of time -- a day or so) and the problem is severe -- crashing bug,
major test failures, etc. -- then ask for objections on the major test failures, etc. -- then ask for objections on the `Django Forum`_
|django-developers| mailing list then revert if there are none. or |django-developers| mailing list then revert if there are none.
* If the problem is small (a feature commit after feature freeze, * If the problem is small (a feature commit after feature freeze,
say), wait it out. say), wait it out.
* If there's a disagreement between the merger and the reverter-to-be then try * If there's a disagreement between the merger and the reverter-to-be then try
to work it out on the |django-developers| mailing list. If an agreement can't to work it out on the `Django Forum`_ or |django-developers| mailing list. If
be reached then it should be put to a vote. an agreement can't be reached then it should be put to a vote.
* If the commit introduced a confirmed, disclosed security * If the commit introduced a confirmed, disclosed security
vulnerability then the commit may be reverted immediately without vulnerability then the commit may be reverted immediately without
@ -249,3 +249,4 @@ When a mistaken commit is discovered, please follow these guidelines:
do a reverse push: ``git push upstream :feature_antigravity``. do a reverse push: ``git push upstream :feature_antigravity``.
.. _ticket tracker: https://code.djangoproject.com/ .. _ticket tracker: https://code.djangoproject.com/
.. _Django Forum: https://forum.djangoproject.com/

26
docs/internals/contributing/triaging-tickets.txt
View File

@ -308,11 +308,12 @@ A ticket can be resolved in a number of ways:
* wontfix * wontfix
Used when someone decides that the request isn't appropriate for Used when someone decides that the request isn't appropriate for
consideration in Django. Sometimes a ticket is closed as "wontfix" with a consideration in Django. Sometimes a ticket is closed as "wontfix" with a
request for the reporter to start a discussion on the |django-developers| request for the reporter to start a discussion on the `Django Forum`_ or
mailing list if they feel differently from the rationale provided by the |django-developers| mailing list if they feel differently from the
person who closed the ticket. Other times, a mailing list discussion rationale provided by the person who closed the ticket. Other times, a
precedes the decision to close a ticket. Always use the mailing list to discussion precedes the decision to close a ticket. Always use the forum
get a consensus before reopening tickets closed as "wontfix". or mailing list to get a consensus before reopening tickets closed as
"wontfix".
* duplicate * duplicate
Used when another ticket covers the same issue. By closing duplicate Used when another ticket covers the same issue. By closing duplicate
@ -332,7 +333,7 @@ If you believe that the ticket was closed in error -- because you're
still having the issue, or it's popped up somewhere else, or the triagers have still having the issue, or it's popped up somewhere else, or the triagers have
made a mistake -- please reopen the ticket and provide further information. made a mistake -- please reopen the ticket and provide further information.
Again, please do not reopen tickets that have been marked as "wontfix" and Again, please do not reopen tickets that have been marked as "wontfix" and
bring the issue to |django-developers| instead. bring the issue to the `Django Forum`_ or |django-developers| instead.
.. _how-can-i-help-with-triaging: .. _how-can-i-help-with-triaging:
@ -353,7 +354,7 @@ Then, you can help out by:
* Closing "Unreviewed" tickets as "needsinfo" when the description is too * Closing "Unreviewed" tickets as "needsinfo" when the description is too
sparse to be actionable, or when they're feature requests requiring a sparse to be actionable, or when they're feature requests requiring a
discussion on |django-developers|. discussion on the `Django Forum`_ or |django-developers|.
* Correcting the "Needs tests", "Needs documentation", or "Has patch" * Correcting the "Needs tests", "Needs documentation", or "Has patch"
flags for tickets where they are incorrectly set. flags for tickets where they are incorrectly set.
@ -371,7 +372,7 @@ Then, you can help out by:
reports about a particular part of Django, it may indicate we should reports about a particular part of Django, it may indicate we should
consider refactoring that part of the code. If a trend is emerging, consider refactoring that part of the code. If a trend is emerging,
you should raise it for discussion (referencing the relevant tickets) you should raise it for discussion (referencing the relevant tickets)
on |django-developers|. on the `Django Forum`_ or |django-developers|.
* Verify if patches submitted by other users are correct. If they are correct * Verify if patches submitted by other users are correct. If they are correct
and also contain appropriate documentation and tests then move them to the and also contain appropriate documentation and tests then move them to the
@ -397,18 +398,19 @@ the ticket database:
checkin", but you should get at minimum one other community member to checkin", but you should get at minimum one other community member to
review a patch that you submit. review a patch that you submit.
* Please **don't** reverse a decision without posting a message to * Please **don't** reverse a decision without posting a message to the
|django-developers| to find consensus. `Django Forum`_ or |django-developers| to find consensus.
* If you're unsure if you should be making a change, don't make the * If you're unsure if you should be making a change, don't make the
change but instead leave a comment with your concerns on the ticket, change but instead leave a comment with your concerns on the ticket,
or post a message to |django-developers|. It's okay to be unsure, or post a message to the `Django Forum`_ or |django-developers|. It's okay to
but your input is still valuable. be unsure, but your input is still valuable.
.. _Trac: https://code.djangoproject.com/ .. _Trac: https://code.djangoproject.com/
.. _`easy pickings`: https://code.djangoproject.com/query?status=!closed&easy=1 .. _`easy pickings`: https://code.djangoproject.com/query?status=!closed&easy=1
.. _`creating an account on Trac`: https://www.djangoproject.com/accounts/register/ .. _`creating an account on Trac`: https://www.djangoproject.com/accounts/register/
.. _password reset page: https://www.djangoproject.com/accounts/password/reset/ .. _password reset page: https://www.djangoproject.com/accounts/password/reset/
.. _Django Forum: https://forum.djangoproject.com/
Bisecting a regression Bisecting a regression
====================== ======================

4
docs/internals/contributing/writing-code/submitting-patches.txt
View File

@ -147,11 +147,13 @@ A "non-trivial" patch is one that is more than a small bug fix. It's a patch
that introduces Django functionality and makes some sort of design decision. that introduces Django functionality and makes some sort of design decision.
If you provide a non-trivial patch, include evidence that alternatives have If you provide a non-trivial patch, include evidence that alternatives have
been discussed on |django-developers|. been discussed on the `Django Forum`_ or |django-developers| list.
If you're not sure whether your patch should be considered non-trivial, ask on If you're not sure whether your patch should be considered non-trivial, ask on
the ticket for opinions. the ticket for opinions.
.. _Django Forum: https://forum.djangoproject.com/
.. _deprecating-a-feature: .. _deprecating-a-feature:
Deprecating a feature Deprecating a feature

4
docs/internals/howto-release-django.txt
View File

@ -402,8 +402,8 @@ Now you're ready to actually put the release out there. To do this:
__ https://github.com/django/djangoproject.com/blob/main/djangoproject/static/robots.docs.txt __ https://github.com/django/djangoproject.com/blob/main/djangoproject/static/robots.docs.txt
#. Post the release announcement to the |django-announce|, |django-developers|, #. Post the release announcement to the |django-announce|, |django-developers|,
and |django-users| mailing lists. This should include a link to the |django-users| mailing lists, and the Django Forum. This should include a
announcement blog post. link to the announcement blog post.
#. If this is a security release, send a separate email to #. If this is a security release, send a separate email to
oss-security@lists.openwall.com. Provide a descriptive subject, for example, oss-security@lists.openwall.com. Provide a descriptive subject, for example,

6
docs/intro/contributing.txt
View File

@ -41,11 +41,13 @@ so that it can be of use to the widest audience.
.. admonition:: Where to get help: .. admonition:: Where to get help:
If you're having trouble going through this tutorial, please post a message If you're having trouble going through this tutorial, please post a message
to |django-developers| or drop by `#django-dev on irc.libera.chat`__ to on the `Django Forum`_, |django-developers|, or drop by
chat with other Django users who might be able to help. `#django-dev on irc.libera.chat`__ to chat with other Django users who
might be able to help.
__ https://diveinto.org/python3/table-of-contents.html __ https://diveinto.org/python3/table-of-contents.html
__ https://web.libera.chat/#django-dev __ https://web.libera.chat/#django-dev
.. _Django Forum: https://forum.djangoproject.com/
What does this tutorial cover? What does this tutorial cover?
------------------------------ ------------------------------