[논문 리뷰] Code Review For and By Scientists

Marian Petre, Greg Wilson|arXiv (Cornell University)|2014. 07. 21.

Software Engineering Research참고 문헌 9인용 수 15

한 줄 요약

이 논문은 과학자들을 대상으로 한 코드 리뷰 관행을 두 개의 피LOT 연구를 통해 조사하여, 종료 후 리뷰보다 즉각적이고 소규모 리뷰가 더 효과적임을 밝혀냈다. 과학자들은 멘토와의 점진적이고 협업적인 코드 리뷰를 통해 코드 품질, 재현 가능성, 재사용성 향상에 기여하며, 특히 정기적인 대화와 명확한 목표 설정이 함께 이루어질 경우 더욱 효과적이다.

ABSTRACT

We describe two pilot studies of code review by and for scientists. Our principal findings are that scientists are enthusiastic, but need to be shown code review in action, and that just-in-time review of small code changes is more likely to succeed than large-scale end-of-work reviews.

연구 동기 및 목표

• 일반적으로 소프트웨어 공학 관행을 체계적으로 이행하지 않는 과학자들에게 코드 리뷰의 타당성과 이점 탐색
• 문서화, 도구 활용, 소통 격차 등 과학 소프트웨어 개발에서 코드 리뷰 도입을 방해하는 요인 규명
• 멘토십과 점진적 연습을 통해 과학 워크플로우에 코드 리뷰를 도입할 수 있는 실용적이고 확장 가능한 전략 개발
• 개발자와 과학자가 코드 리뷰를 어떻게 다르게 인식하는지 이해하고, 이를 효과적인 협업을 위해 연결하는 방법 모색
• 과학 연구 팀에서 지속 가능하고 부담이 적은 코드 리뷰 프로세스를 구현하기 위한 가이드라인 수립

제안 방법

• 과학 분야에 익숙지 않은 전문 개발자들이 PLOS Computational Biology의 과학 소프트웨어를 후행적으로 리뷰함
• 11명의 개발자와 4명의 코드 저자와의 반구조화된 인터뷰를 통해 리뷰 품질, 사용성, 인식된 가치 평가
• 경험이 풍부한 과학 프로그래머와 경험이 적은 과학자를 조합하여 멘토십을 통한 코드 리뷰 기술 이관을 위한 두 번째 피LOT 연구 시행
• 정기적이고 동기화된 리뷰 세션(매 3~4주 간격)을 강조하며, 명확한 목표, 일정, 상호 피드백을 통해 유대감과 신뢰를 구축
• 대규모 리팩터링이 아닌, 각 코드 변경 시마다 문서화 및 테스트 작성과 같은 점진적 개선을 장려
• 실제 연구 프로젝트에서 유래한 실제 코드베이스를 사용하며, 초기 리뷰를 위해 활발히 개발 중인 3~4페이지 내외의 독립형 모듈에 집중

실험 결과

연구 질문

• RQ1 도메인 전문 지식이 없는 비과학자 개발자가 과학 소프트웨어를 효과적으로 리뷰할 수 있는가?
• RQ2 과학자와 개발자가 코드 품질과 문서화에 대해 기대치, 기준, 관행에서 어떻게 다를까?
• RQ3 과학 소프트웨어 개발에서 코드 리뷰 도입을 방해하는 주요 장애물은 무엇이며, 이를 어떻게 극복할 수 있는가?
• RQ4 즉각적이고 소규모 리뷰는 대규모 종료 후 리뷰에 비해 효과성과 도입 측면에서 어떻게 다를까?
• RQ5 인간관계 소통과 멘토십은 과학자들 사이에서 성공적인 코드 리뷰 도입에 어떤 역할을 하는가?

주요 결과

• 과학자들은 코드 리뷰에 열정을 보이지만, 버전 제어, 테스팅, 문서화와 같은 소프트웨어 공학 관행에 대한 경험 부족함을 보인다.
• 비과학자 개발자가 수행한 후행적 비동기 리뷰는 도메인 맥락 부족, 코드 접근 제한, 대화 부재로 인해 '드라이브바이' 리뷰로 인식됨.
• 작동 예제나 빌드 지침이 없어 코드 검증이 어려워졌고, 문서화 부족으로 많은 경우 가정을 해야 하는 상황에 봉착함.
• 과학자들은 종종 재사용을 위해 코드를 패키징하거나 문서화하지 않으며, 이는 과학적 성과에 비해 코드 품질이 덜 중요시되는 문화적 관습 반영.
• 개발자와 과학자 모두 리뷰 중 더 많은 대화를 원하며, 이는 이해를 향상시키고 피드백 품질을 높이며 신뢰를 구축하는 데 기여함.
• 가장 효과적인 코드 리뷰 프로세스는 정기적이고 동기화된 대화, 명확한 목표, 각 변경 시마다 문서화 및 테스트 추가와 같은 점진적 개선을 포함하며, 대규모 전환보다 효과적임.