반응형
이런 방식으로 마크 다운 주석으로 작성하면, 작성중인 개발자에게는 메세지를 안내할 수 있고 작성 후에는 주석처리되어 보이지 않습니다.
<-- 가이드 메세지 -->
인용구 방식을 사용하면 작성 중일때에도 보일 수 있고, 작성 후에도 흐리게 처리되어 부가 정보를 나타낼 수 있습니다.
> 메세지
다만, 인용구는 작성 후에도 보일 필요없는 정보까지 보이게 되어 불필요하게 PR이 길어질 수 있어 핵심 내용이 바로 보이지 않을 수 있으니 적절히 사용해야합니다.
작성중인 개발자에게만 보일 필요가 있는 정보는 주석을 이용하도록 합니다.
반응형
'Web Development' 카테고리의 다른 글
퇴사 부검 ⚰️ (4) | 2024.09.30 |
---|---|
Issue 템플릿 작성하기(라벨, 할당자, 타이틀 자동 설정, 오픈소스 참고) (0) | 2024.08.29 |
[AWS elastic beanstalk] postgresql, redis 설치하기(feat. GPT 드리븐 디벨롭먼트) (0) | 2024.08.05 |
[읽어줘] 한국어 TTS API 서비스 비교 분석 - 서비스 기획(1) (4) | 2024.05.29 |
[기술문서] 디자인 시스템, 패턴 라이브러리, 스타일 가이드와 컴포넌트 라이브러리의 차이점 (0) | 2024.05.28 |