코드 심사:github 공식이 제시한 코드 심사 지도 원칙

2677 단어 코드 검토테크닉
이 글의 내용은 github 정부에서 제공하여 github에서 코드 심사와 다른 사람이 자신의 코드를 심사하도록 지도합니다.

모두에 대한 심사

  • 이러한 사실을 받아들인다. 많은 프로그래밍상의 주장은 개인적인 관점이다.그것들의 이익과 폐단을 토론하고 성향의 관점을 제시하여 신속하게 해결 방안을 달성해야 한다.
  • 명령이 아니라 질문.(이 변수를 :user_id로 명명하는 것은 어떻습니까?)
  • 설명 요청.("모르겠어요.설명 좀 해주시겠어요?"
  • 코드의 귀속 분쟁을 피한다.("내꺼", "내꺼 아니야", "너꺼야")
  • 인신 특징으로 여겨질 수 있는 단어의 사용을 피한다.(바보, 바보) 모든 사람을 매력적이고 똑똑하며 선의로 여겨야 한다.
  • 명확해야 한다.모든 사람이 너의 의도를 이해할 수 있는 것은 아니라는 것을 기억해라.
  • 겸손해야 한다.("나는 확실하지 않다. 우리가 분석해 보자."
  • 과장된 수사어를 쓰지 마세요.("항상", "아니요", "영원히", "아무것도...")
  • 풍자하지 마세요.
  • 진실한 너를 보여줘.만약 당신이 유머러스한 사람이 아니라면, 이모티콘이나 애니메이션gif도를 사용하는 것을 좋아하지 않는다. 무리하지 마라.만약 당신이 이런 사람이라면, 자신감을 발휘해 보세요.
  • 만약에'나는 이해하지 못한다'거나'다른 방안:'이라는 댓글이 너무 많으면 이 사람을 대상으로 의사소통을 하세요.당신들의 오프라인 교류를 하나의 게시물로 정리하여 뒤에 첨부할 수 있습니다.

    • 다른 사람이 너의 코드를 심사하도록 해라

  • 심사자의 건의에 감사를 드립니다."깨우쳐 줘서 고마워요. 고칠게요."
  • 이해 심사는 옳지 않은 일이다.심사하는 것은 너의 코드이지, 너가 아니다.
  • 코드가 왜 이렇게 쓰였는지 설명한다.("xxx 때문에 이렇게 썼어요. 이 클래스/파일/방법/변수를 바꾸면 더 뚜렷할까요?"
  • 변동을 정리하고 이후의 교체에서 재구성한다.
  • 수정된 버전에 코드 심사 링크를 명시한다.(“Ready for review: http://github.com/organization/project/pull/1″)
  • push 제출은 최초의 피드백을 바탕으로 하나의 독립된 지점을 형성해야 한다.이 지점의 임무가 완전히 완성되면 다시 합병한다.이것은 심사자들이 이전의 피드백에 따라 당신의 단독 업데이트를 찾을 수 있게 한다.
  • 심사자의 입장에서 이해하려고 노력한다.
  • 모든 평론에 답장을 쟁취한다.
  • 마지막 사람이 로그인을 종료한 후에 지점을 합병합니다.
  • 통합 테스트(TDDIUm, TravisCI, 등)가 이 지점의 테스트 세트가 통과된 후에 지점을 합병할 때까지 지속한다.

    • 코드 검토 과정


    먼저 당신이 제출한 코드의 필요성을 알아야 한다. (버그를 수정하고 사용자 체험을 향상시키고 재구성하는 것이다.)다음:
  • 당신이 매우 좋다고 느끼는 곳과 그렇지 않은 곳을 대상으로 작가와 교류한다.
  • 문제를 해결할 수 있을 뿐만 아니라 코드도 간소화할 수 있는 방법을 찾아낸다.
  • 토론이 지나치게 철학적이거나 이론적으로 변하면 토론을 오프라인으로 돌려 규칙적인 매주 금요일 오후 토론회를 만든다.동시에 당신이 제시한 실현 방안을 채택할지 말지는 작가 스스로 결정하도록 하세요.
  • 당신의 실현 방안을 제시하지만 작가도 이런 방안을 고려하고 있음을 보여야 한다.(이곳에 사용자 정의 검사를 사용하는 것이 어떻다고 생각합니까?)
  • 저자의 입장을 이해하기 위해 노력한다.
  • pull이 로그아웃을 요청할 때'합병할 수 있다'는 주석을 추가합니다.

    • 프로그램 스타일 스타일에 대한 평론 주석


    심사자는 양식 지도에 부합되지 않는 부분에 대해 주석을 달아야 한다.예를 들면 다음과 같습니다.
      [Style](../style):

>               。

    ：

       。    ，  。   a4994ec   。

    ， repo ， 。 ， 。

    IT ( www.aqee.net) ， ： ：github
    UDP, TCP 개념정리
    P2: 디자인 패턴 프로그래밍

    좋은 웹페이지 즐겨찾기

    개발자 우수 사이트 수집

    개발자가 알아야 할 필수 사이트 100선 추천 우리는 당신을 위해 100개의 자주 사용하는 개발자 학습 사이트를 정리했습니다
    best100-homepage