Submitting contributions¶

오타 수정 및 사소한 문서 변경 사항입니다.¶

설명서에서 단어를 변경하는 등 매우 사소한 문제를 수정하는 경우 패치를 제공하는 기본 방법은 Trac 티켓 없이 GitHub 풀 요청을 사용하는 것입니다.

pull 요청을 사용하는 방법에 대한 자세한 내용은 :doc:’working-with-git’을 참조하십시오.

티켓을 “청구하기”¶

전 세계에 수백 명의 기여자가 있는 오픈소스 프로젝트에서는 작업이 중복되지 않고 기여자가 최대한 효과적으로 작업할 수 있도록 커뮤니케이션을 효율적으로 관리하는 것이 중요합니다.

따라서 우리의 정책은 특정 버그나 기능이 작업 중임을 다른 개발자에게 알리기 위해 티켓을 “청구”하는 기여자를 위한 것입니다.

원하는 기여가 확인되었고 이를 수정할 수 있는 능력이 있는 경우(코딩 능력, Django 내부 지식 및 시간 가용성으로 측정됨) 다음 단계를 수행하여 해당 기여를 청구합니다.

• 저희 티켓 시스템에서 “GitHub account” 또는 “create account”를 사용하여 로그인하십시오. 계정이 있지만 암호를 잊어버린 경우 ‘비밀번호 재설정 페이지’를 사용하여 재설정할 수 있습니다.

• 이 문제에 대한 티켓이 아직 존재하지 않는 경우 “티켓 추적기”에 티켓을 만드십시오.

• 이 문제에 대한 티켓이 이미 있는 경우 다른 사람이 해당 티켓을 청구하지 않았는지 확인하십시오. 이렇게 하려면 티켓의 “소유자” 섹션을 참조하십시오. “아무도”에게 할당된 경우 청구할 수 있습니다. 그렇지 않으면 다른 사람이 이 티켓을 작업하고 있을 수 있습니다. 작업할 다른 버그/기능을 찾거나 티켓 관련 개발자에게 문의하여 도움을 요청하십시오. 몇 주 또는 몇 달 동안 아무런 작업 없이 티켓이 할당된 경우 자신에게 티켓을 다시 할당하는 것이 안전할 수 있습니다.

• Log into your account, if you haven’t already, by clicking “GitHub Login” or “DjangoProject Login” in the upper left of the ticket page. Once logged in, you can then click the “Modify Ticket” button near the bottom of the page.

• Claim the ticket by clicking the “assign to” radio button in the “Action” section. Your username will be filled in the text box by default.

• Finally click the “Submit changes” button at the bottom to save.

Contribution style¶

최소한 다음 요구 사항을 충족하는 기여가 있는지 확인하십시오.

• The code required to fix a problem or add a feature is an essential part of a solution, but it is not the only part. A good fix should also include a regression test to validate the behavior that has been fixed and to prevent the problem from arising again. Also, if some tickets are relevant to the code that you’ve written, mention the ticket numbers in some comments in the test so that one can easily trace back the relevant discussions after your patch gets committed, and the tickets get closed.

• If the code adds a new feature, or modifies the behavior of an existing feature, the change should also contain documentation.

When you think your work is ready to be reviewed, send a GitHub pull request. If you can’t send a pull request for some reason, you can also use patches in Trac. When using this style, follow these guidelines.

• “git diff” 명령으로 반환된 형식으로 패치를 제출합니다.

• “첨부 파일” 버튼을 사용하여 “티켓 트래커”의 티켓에 패치를 첨부합니다. 한 줄 패치가 아닌 경우 티켓 설명이나 코멘트에 패치를 넣지 마십시오.

• 패치 파일의 이름을 “.diff” 확장자로 지정합니다. 이렇게 하면 티켓 추적기가 올바른 구문 강조 표시를 적용할 수 있으므로 매우 유용합니다.

작업 제출 방법과 상관없이 다음 단계를 따르십시오.

• Make sure your code fulfills the requirements in our contribution checklist.

• 티켓의 “패치 있음” 상자를 선택하고 “문서 필요”, “테스트 필요” 및 “패치 개선 필요” 상자를 선택하지 않았는지 확인합니다. 이렇게 하면 티켓이 “개발 대시보드”의 “검토가 필요한 패치” 대기열에 나타납니다.

Contributions which require community feedback¶

A wider community discussion is required when a patch introduces new Django functionality and makes some sort of design decision. This is especially important if the approach involves a deprecation or introduces breaking changes.

The following are different approaches for gaining feedback from the community.

기능을 사용¶

Django의 코드가 더 이상 사용되지 않는 몇 가지 이유가 있습니다.

• 기능이 이전 버전과 호환되지 않는 방식으로 개선되거나 수정된 경우 이전 기능 또는 동작은 더 이상 사용되지 않습니다.

• 때때로 Django는 Django가 현재 지원하는 Python 버전에 포함되지 않은 Python 라이브러리의 백포트를 포함할 수 있습니다. Django가 라이브러리를 포함하지 않는 이전 버전의 Python을 더 이상 지원할 필요가 없으면 Django에서 라이브러리가 사용되지 않습니다.

:ref:’감가상각 정책’에서 설명한 것처럼 기능을 사용하지 않는 Django의 첫 번째 릴리스(‘’A’)입니다.B’’)는 사용되지 않는 기능이 호출될 때 “제거된 장고 XX 경고”(여기서 XX는 기능이 제거될 장고 버전)를 발생시켜야 합니다. 테스트 범위가 양호하다고 가정하면, 경고가 활성화된 상태에서 :ref:’test Suite’를 실행하면 이러한 경고가 오류로 변환됩니다. ‘’’와 - 와 runtests.py’’’’입니다. 따라서 “RemovedInDjangoXXWarning”을 추가할 때 테스트를 실행할 때 발생하는 경고를 제거하거나 침묵시켜야 합니다.

첫 번째 단계는 Django가 사용하지 않는 동작의 사용을 제거하는 것입니다. 그런 다음 테스트 또는 클래스 수준에서 “ignore_warnings” 데코레이터를 사용하여 권장되지 않는 동작을 실제로 테스트하는 테스트에서 경고를 음소거할 수 있습니다.

1. 특정 테스트의 경우:

   from django.test import ignore_warnings
   from django.utils.deprecation import RemovedInDjangoXXWarning
   
   
   @ignore_warnings(category=RemovedInDjangoXXWarning)
   def test_foo(self): ...
   

2. 전체 테스트 사례의 경우:

   from django.test import ignore_warnings
   from django.utils.deprecation import RemovedInDjangoXXWarning
   
   
   @ignore_warnings(category=RemovedInDjangoXXWarning)
   class MyDeprecatedTests(unittest.TestCase): ...
   

You should also add a test for the deprecation warning:

from django.utils.deprecation import RemovedInDjangoXXWarning


def test_foo_deprecation_warning(self):
    msg = "Expected deprecation message"
    with self.assertWarnsMessage(RemovedInDjangoXXWarning, msg) as ctx:
        # invoke deprecated behavior
        ...
    self.assertEqual(ctx.filename, __file__)

It’s important to include a RemovedInDjangoXXWarning comment above code which has no warning reference, but will need to be changed or removed when the deprecation ends. This could include hooks which have been added to keep the previous behavior, or standalone items that are unnecessary or unused when the deprecation ends. For example:

import warnings
from django.utils.deprecation import RemovedInDjangoXXWarning


# RemovedInDjangoXXWarning.
def old_private_helper():
    # Helper function that is only used in foo().
    pass


def foo():
    warnings.warn(
        "foo() is deprecated.",
        category=RemovedInDjangoXXWarning,
        stacklevel=2,
    )
    old_private_helper()
    ...

마지막으로 Django의 문서에는 다음과 같은 몇 가지 업데이트가 있습니다.

1. 기존 기능이 문서화된 경우 ‘’를 사용하여 문서에서 사용되지 않는 것으로 표시합니다. 사용되지 않음: A입니다.B’ 주석입니다. 해당되는 경우 간단한 설명과 업그레이드 경로에 대한 참고 사항을 포함합니다.

2. 권장되지 않는 동작에 대한 설명과 적용 가능한 업그레이드 경로가 있다면 현재 릴리스 정보(‘’docs/releases/A’.B.txt”)를 “A.B에서 사용되지 않는 기능입니다” 헤드에 추가합니다.

3. 제거될 코드를 설명하는 항목을 해당 버전의 사용 중지 타임라인(docs/internals/deprecation.txt)에 추가합니다.

이 단계를 완료하면 더 이상 사용되지 않습니다. 각 :term:’feature release’에서 새 버전과 일치하는 모든 “RemovedInDjangoXXWarning”s가 제거된다.

JavaScript contributions¶

For information on JavaScript contributions, see the JavaScript 패치 documentation.

Optimization patches¶

Patches aiming to deliver a performance improvement should provide benchmarks showing the before and after impact of the patch and sharing the commands for reviewers to reproduce.

Contribution checklist¶

Use this checklist to review a pull request. If this contribution would not be considered trivial, first ensure it has an accepted ticket before proceeding with the review.

If the pull request passes all the criteria below and is not your own, please set the “Triage Stage” on the corresponding Trac ticket to “Ready for checkin”. If you’ve left comments for improvement on the pull request, please tick the appropriate flags on the Trac ticket based on the results of your review: “Patch needs improvement”, “Needs documentation”, and/or “Needs tests”. As time and interest permits, mergers do final reviews of “Ready for checkin” tickets and will either commit the changes or bump it back to “Accepted” if further work needs to be done.

If you’re looking to become a member of the triage & review team, doing thorough reviews of contributions is a great way to earn trust.

Looking for a patch to review? Check out the “Patches needing review” section of the Django Development Dashboard.

Looking to get your pull request reviewed? Ensure the Trac flags on the ticket are set so that the ticket appears in that queue.