개발자를 위한 변경 로그?

보시다시피 저는 최근에 프로젝트의 버스 팩터를 높이는 방법을 묻는 게시물을 작성했습니다.

버스 팩터를 높이는 방법은 무엇입니까?

스콧 해리슨 ・ 2018년 7월 19일 ・ 1분 읽기

#discuss

몇 가지 훌륭한 응답이 있었고 우리 팀은 코드 검토를 제출할 때 다른 모든 개발자를 검토자로 선택하는 프로세스를 채택했습니다(모든 개발자가 번거로울 수 있기 때문에 요청을 승인해야 하는 것은 아닙니다). 이는 팀 내 프로젝트 및 개발자 간의 지식 공유에 도움이 됩니다.

프로젝트에서 함께 작업하는 개발자 팀 사이의 공통적이고 관련된 문제는 프로젝트 내에서 코드, 디자인 또는 DevOps 관련 변경 사항이 변경될 때 모든 사람이 루프에 있도록 하는 것입니다.

내가 생각한 가능한 솔루션은 일종의 변경 로그이지만 최종 사용자가 아닌 개발자를 위한 것입니다. 아이디어는 각 프로젝트의 루트에 기능이 마스터 분기에 병합될 때마다 업데이트되는 changelog.md 파일이 있다는 것입니다. 메시지는 단순해야 하지만 미래의 개발자가 이해하는 데 관련이 있을 수 있는 모든 내용을 전달해야 합니다.

예를 들어, 최근에 개발자가 docker 설정을 변경하고 readme.md를 업데이트하여 이 변경 사항을 반영했지만 새 기능을 추가하기 위해 프로젝트를 선택할 때 readme.md를 확인하지 않았고 내 환경은 일하다. 커밋 기록을 살펴보거나 다른 개발자를 방해하는 대신 단순히 changelog.md 파일을 보고 다음을 볼 수 있었습니다.

31/07/2018
- Now use docker-sync for handling storage in project, details of what you need to change in README.md

이 간단한 메시지는 내가 프로젝트를 다시 선택하고 참여하기 전에 알아야 할 모든 것을 알려줍니다. 이것은 커밋 메시지의 중복으로 보일 수 있지만 커밋 메시지는 변경된 내용에 대한 기술적인 세부 정보를 제공하는 경우가 많습니다. 특히 해당 부분을 건드리지 않는 경우 프로젝트로 다시 뛰어들 때 항상 중요하지는 않습니다. 그러나 상위 수준에서 변경된 사항에 대한 한 문장 개요를 얻는 것이 편리할 수 있습니다.

동료가 나에게 이것을 보여주었고 이것은 내가 염두에 두었던 것과 일치하는 것 같습니다: https://keepachangelog.com/en/1.0.0/

어떻게 생각해?