SourceControl의 변경 사항에 대한 좋은 의견 [폐쇄
https://stackoverflow.com/questions/854809
-
21-08-2019 - |
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
Russian문제
버전 제어 시스템 (예 : TFS)에 코드를 등록 할 때 의견을 작성하기위한 지침을 개발해야합니다.
예를 들어, Bugfix를 제출할 때 "고정 버그 #..."주석을 만듭니다.
우리는이 주제에 대해 브레인 스토밍을 시도했지만 대부분의 아이디어는 부가가치가 너무 적습니다.
나는 이것에 대한 제안에 감사드립니다.
해결책
일반적으로 우리가 내가 일하는 곳에서하는 의견은 변경된 변경 사항에 대한 빠른 개요입니다. 짧고 단순한 것.
처음에는 많은 가치를 더하는 것 같지만, 무언가가 바뀌었을 때 ( "버그 ######"보다 훨씬 더 많은 것을 찾으려고 역사를 되돌아 갈 때 매우 도움이 될 수 있습니다. 특정 동작이나 코드 조각이 변경된시기를 찾아서 찾기 위해 소스 제어 기록을 되돌아 가야 할 때가 몇 번이나 있었으며 빠른 개요를 통해 그 위치를 훨씬 쉽게 추적 할 수 있습니다. 버그 번호 만 제공하는 경우 해당 기본 정보를 찾으려면 더 많은 작업을 수행해야합니다 (버그 추적기를 당기고 버그를 찾으십시오).
다른 팁
이 주제에 대한 나의 (다소 pithy) 지침은 "문서화하기 위해 왜 당신은 변화를 만들고 있습니다 무엇."
즉, "myclass.cs 및 foobar.cs에서 고정 버그"라고 말해서는 안됩니다. 그 주석은 상당히 관련이 없기 때문입니다. 그들은 변경 사항을보고 해당 세부 사항을 찾을 수 있습니다. 마찬가지로 TFS와 마찬가지로 변경 세트를 작업 항목에 연결하는 것은 주석에 작업 항목 참조를 포함시키는 것이 매우 불필요하다는 것을 의미합니다. 대신 "편집자의 고정 전위 XSS 취약성"과 같은 변화의 이유를 설명하는 짧은 문장은 큰 변화 세트의 역사를 살펴볼 때 읽는 가장 유용한 것입니다.
릴리스 노트에 언급 될 변경을 위해 제안 된 릴리스 노트 항목을 포함하십시오, 변경 사항 주석 또는 링크 된 버그 보고서가있는 경우.
릴리스 노트 항목을 작성하면 한 걸음 물러서서 사용자의 관점에서 편집을보아야합니다. 이것은 문제의 문제와 수정이 문제를 해결하는 방법을 간결하게 설명하도록 권장합니다.
TFS를 구성하여 모든 코드 체크인에 TFS 작업과 관련된 TFS 작업이 있어야합니다.
내가 일하는 곳에서이를 사용하는 프로젝트 팀은 모든 버그 및 / 또는 기능을 TFS로 작업으로 입력하고 모든 코드 체크인이 적용되는 작업과 연관되어야합니다.
의견도 필요하지만 변경 사항을 다른 지점으로 전달할 필요가없는 경우를 제외하고는 작성한 내용에 대한 엄격한 지침이 없습니다.
변경 사항에 어딘가에 관련된 티켓이있는 경우,이 경우 숫자와 제목 (링크 포함)이 충분해야합니다.
그렇지 않으면 어떤 변화를 구현했는지 명시하십시오. 정기적 인 주석 가이드 라인이 적용되면 인기있는 프로젝트 로그를 확인하여 좋은 예를 확인할 수 있습니다.
가능한 경우 (예 : 버그 추적 및 소스 제어에 TFS를 사용할 때와 같은) 체크인을 적절한 작업 항목에 직접 연결하십시오. 실패하면 Changeet 주석에 작업 항목 / 버그 #을 추가하십시오. 이것은 최소 수용 가능한 수준의 Changeet 주석입니다.
Checkin Comment는 변경의 의도를 설명해야하며 변경이 필요한 결과를 얻는 방법에 대한 세부 사항 만 추가해야합니다. 좋은 출발점은 적절한 작업 항목의 제목입니다.
하나 또는 두 문장은 주석의 좋은 대상 길이입니다. 그렇게 일반적이지 마십시오. 주석은 의미가 없지만 (예 : "xyz로 버그를 수정했습니다") 불필요한 세부 사항의 계층에서 변경 의도를 숨기지 마십시오.
나는 가능한 경우 버그 (티켓, 문제, 그에 대한 부름)에 대한 참조를 포함하고 싶습니다. 그것은 변화의 맥락과 동기를 제공하기 때문입니다. 또한, 나는 무엇이 바뀌었고 왜 가능한 한 한 줄에 가까운 이유에 대답하려고 노력하고 싶습니다. 댓글을 작성할 때 6 개월 만에 내 미래의 자아에 대해 통나무, 차이 및 티켓을 되돌아보고 도대체 내가 무엇을 생각했는지 이해합니다. 너무 많은 세부 사항을 얻는 것은 결코 도움이되지 않는 것 같습니다.
버그 문제 제목을 붙여 넣기위한 +1은 유익해야합니다.
+1 문서의 경우 필요한 경우 버그 제목 외에 필요한 이유.
고객에게 알리고 싶을 때 릴리스 노트에 대해 의식하는 +1.
SCM, 버그 추적 및 CI를 통합하고 문제/ 버그에 대해 서로 연결하는 +1.
