풀 리퀘스트 검토 제공

BeeWare 프로젝트에 기여된 모든 내용을 누구나 검토할 수 있습니다. 시작하기 전에 알아두어야 할 몇 가지 중요한 사항이 있습니다.

리뷰하기 전에 생각하세요

검토에 착수하기 전에, 생각하라. 검토자로서 우리는 보내려는 답변이 다음과 같은지 고려해야 한다:

• 맞습니다. 항상 정확한 제안과 정보를 제공하기 위해 노력하십시오.
• 도움이 됩니다. 제출물을 개선하는 방법에 대한 지침을 제공하고 있습니다. 이 지침은 문제의 원인이나 고려되지 않은 사용 사례를 명확히 지적해야 하며, 이상적으로는 해당 문제를 해결하거나 우려 사항을 해소할 수 있는 해결 방안을 제시해야 합니다.
• 고무적입니다. 우리가 요청한 변경 사항을 반영하도록 저자에게 동기를 부여하는 것은 우리에게 달려 있습니다.
• 필요한 경우에만 게시해야 합니다. 작성자가 우리가 게시하는 모든 내용을 읽을 것으로 기대되므로, 그들의 시간과 노력을 존중하기 위해 필요한 경우에만 게시해야 합니다.
• 친절하게. 동일한 피드백을 전달하는 방법은 여러 가지가 있습니다. 우리는 우리의 말이 친절하고, 지지적이며, 건설적인 선택을 하고 있는지 확인해야 합니다.

효과적인 리뷰를 제공하면서도 생각을 하는 것은 충분히 가능합니다. 위에서 논의한 개념들은 PR에서 발견한 문제를 지적하는 것을 배제하지 않습니다. 기여자들은 개선이 필요한 부분을 인지하지 못하면 자신의 기여를 개선할 기회를 얻지 못할 것입니다. 중요한 것은 이러한 피드백을 어떻게 제시하는지에 대한 인식입니다. 리뷰를 개인화하지 않도록 노력하세요. "당신이 실수를 했습니다" 대신 "이 코드는 개선될 수 있습니다"라고 말할 수 있습니다. 작성자가 아닌 코드를 검토하세요.

개선이 필요한 부분을 지적하는 것 외에도 긍정적인 피드백을 제공하는 것을 잊지 않는 것이 중요합니다. 예를 들어, 변경 사항이 특히 유용하거나, 특히 영리한 작업을 수행했거나, 알지 못했던 API를 소개받았다면 작성자에게 알려주세요! 다른 모든 지적 사항이 해결해야 할 문제들인 상황에서, 누군가가 올바르게 또는 잘 수행한 부분을 지적하는 효과가 결코 작지 않다는 점을 과소평가하지 마십시오.

GitHub 검토 제안

GitHub 리뷰 인터페이스에는 변경 제안 기능이 있습니다. 이 기능을 통해 기존 콘텐츠를 대체할 정확한 변경 사항을 제안할 수 있습니다. 제안된 변경 사항은 커밋되기 전까지는 프리커밋 및 린팅 검사를 거치지 않는다는 점을 유의하십시오. 따라서 이 기능은 소규모 변경에 사용해야 합니다. 제안된 변경 사항이 클수록 문제를 유발할 가능성이 높아지기 때문입니다.