CodeStream에서 코드 토론

코드마크란?

간단히 말해서 코드마크는 코드와 연결된 토론 입니다. 질문, 제안, 버그 보고서 또는 문서가 될 수 있습니다. 이러한 모든 토론은 참조하는 코드 블록에 고정되어 저장되므로 나중에 활용할 수 있습니다. 팀에 합류한 새로운 개발자, 다른 사람의 코드에서 버그를 수정하려는 개발자, 또는 6개월 전에 변경한 이유를 기억하려는 개발자일 수도 있습니다. 어떤 경우이든 CodeStream은 상황에 맞는 방식으로 토론을 표시하여 코드를 이해하는 데 도움이 됩니다.

시간이 지남에 따라 파일이 변경되더라도 코드마크는 코드에 연결된 상태로 유지됩니다. 코드 블록 위에 새로운 코드 줄을 추가하거나 코드를 수정하거나 전체 블록을 잘라내어 파일의 다른 섹션에 붙여 넣으면 변경 사항과 함께 코드마크가 움직이는 것을 볼 수 있습니다.

다음은 팀이 코드마크를 사용하여 IDE의 코드에서 공동 작업하는 방법을 보여주는 짧은 비디오(3분 15분)입니다.

코드마크 개요

CodeStream 창의 코드마크 섹션에는 쉽게 참조할 수 있도록 현재 리포지토리에 있는 모든 코드마크가 나열됩니다.

코드마크 섹션에서 항목을 클릭하여 세부 정보 및 토론을 검토하십시오. pull-request 댓글을 제외하고 오른쪽의 거품은 응답 수를 보여줍니다.

기본적으로 현재 저장소의 모든 코드마크가 표시되지만 필터를 변경하여 현재 분기의 모든 코드마크, 현재 폴더의 코드마크 또는 현재 선택한 파일의 코드마크를 표시할 수 있습니다.

피드백 및 끌어오기 요청의 코드마크는 현재 파일 필터를 선택한 경우에만 나타납니다.

코드마크 섹션 머리글 위로 마우스를 가져가면 오른쪽에 다음 아이콘이 나타납니다.

codemarks 헤더에는 코드 주석 또는 문제를 생성하는 옵션이 포함되어 있습니다. 목록 대신 공간 보기에서 코드마크를 보도록 선택할 수도 있습니다. 토론은 참조하는 코드 블록과 함께 표시되며 소스 파일을 스크롤하면 토론도 함께 스크롤됩니다.

목록을 더 많이 제어하려면 톱니바퀴 아이콘을 클릭하세요.

• 여러 줄 주석 줄 바꿈 : 코드마크의 잘린 부분을 표시하는 대신 목록에 전체 게시물이 표시됩니다.
• 태그 표시 : 적용 가능한 모든 태그가 각 코드마크와 함께 표시됩니다.
• 주석 정렬 기준: 기본적으로 코드마크는 날짜순으로 정렬되지만 필터가 현재 파일로 설정된 경우 줄 번호(예: 파일에서의 순서)로 정렬할 수 있습니다.
• 편집기 여백에 아이콘 표시 : 코드마크 섹션의 목록에 표시되는 것 외에도 코드마크는 참조하는 코드 블록과 함께 편집기 여백에 아이콘으로 표시됩니다. 어떤 유형의 코드마크와 어떤 상태를 표시할 것인지 결정할 수 있습니다. 기본적으로 피드백 요청의 코드마크는 표시되지만 풀 요청 주석은 표시되지 않습니다. 해결된 코드마크도 기본적으로 표시되지만 보관된 코드마크는 표시되지 않습니다.

코드마크 생성

코드마크를 생성하려면 편집기에서 코드 블록을 선택한 다음 선택 항목 옆에 있는 CodeStream 창에 나타나는 아이콘 중 하나를 클릭합니다.

IntelliJ와 같은 JetBrains IDE를 사용하는 경우 코드 블록을 선택할 때 편집기의 여백에 나타나는 + 버튼을 통해 코드마크를 생성할 수도 있습니다. diff를 볼 때 피드백 요청이나 끌어오기 요청에 대해 한 줄에 쉽게 댓글을 달 수 있도록 여백 위로 마우스를 가져가면 버튼도 나타납니다.

CodeStream 창이 닫혀 있거나 보이지 않는 경우에도 전구 또는 컨텍스트 메뉴의 CodeStream 옵션을 통해 코드마크를 생성할 수 있습니다.

CodeStream 창 상단에서 + 메뉴를 찾을 수도 있습니다.

IDE에서 많은 시간을 보내지 않는 팀원에게 연락해야 합니까? 아니면 아직 CodeStream에 없는 팀원이 있습니까? 선택적으로 코드마크를 Slack 또는 Microsoft Teams에 공유할 수 있습니다. Slack 통합을 통해 팀원들이 Slack에서 직접 응답할 수도 있습니다.

주석 코드마크

주석 코드마크는 모든 유형의 토론을 코드 블록에 연결하기 위한 다목적 코드마크입니다. 질문하세요. 제안을 합니다. 일부 코드를 문서화하십시오. 코드베이스의 주요 섹션을 기록해 두십시오. 가능성은 무한합니다.

코드마크 발행

뭔가를 해야 할 때 누군가의 이름이 첨부된 문제로 포착되면 일이 일어날 가능성이 더 높습니다. 버그를 보고하는 방법으로 문제를 할당하거나 인라인 FIXME 대신 추적된 문제로 항목을 캡처하여 기술 부채를 관리합니다.

팀에서 추적을 위해 Asana, Azure DevOps, Bitbucket(클라우드), GitHub(클라우드 또는 엔터프라이즈), GitLab(클라우드 또는 자체 관리), Jira(클라우드 또는 서버), Linear, Shortcut, Trello 또는 YouTrack(클라우드)을 사용하는 경우 문제가 있는 경우 CodeStream에서 직접 해당 서비스 중 하나에 문제를 생성할 수 있습니다. 코드마크 양식 상단의 드롭다운에서 사용하는 서비스를 선택합니다.

선택한 서비스로 인증 절차를 거친 후 문제의 대상을 선택할 수 있습니다. 예를 들어 Jira를 사용하면 적절한 문제 유형과 프로젝트를 선택할 수 있습니다.

CodeStream에서 문제가 생성되면 외부 서비스에서 생성된 문제에 대한 링크가 포함됩니다. 예에서 Jira의 문제에 대한 URL을 볼 수 있습니다.

Jira의 문제에는 IDE에서 관련 코드를 여는 링크가 포함되어 있습니다.

적절한 사람들을 토론에 참여시키십시오.

코드마크를 생성하면 CodeStream은 귀하가 댓글을 달고 있는 코드를 가장 최근에 터치한 사람들을 자동으로 언급합니다. 그들은 귀하의 질문에 가장 잘 대답할 수 있지만, 물론 해당 멘션을 제거하고 적절한 경우 다른 사람을 수동으로 멘션할 수 있습니다.

코드를 만진 사람들이 아직 CodeStream에 없는 경우일 수 있습니다. 이 경우 CodeStream은 이메일을 통해 알림을 받을 수 있는 확인란을 제공합니다. 이메일에 답장하여 CodeStream에 댓글을 게시할 수 있으며 물론 IDE에서 참여하기 위해 CodeStream을 설치할 수 있습니다.

다른 버전의 코드로 작업

기능 분기에 있거나 로컬 변경 사항이 있거나 잠시 동안 가져오지 않았을 수 있습니다. 보고 있는 코드가 팀원이 보고 있는 것과 다를 수 있는 데에는 셀 수 없이 많은 이유가 있습니다. 결과적으로 코드마크에서 참조하는 코드가 로컬에 있는 것과 일치하지 않는 경우가 많습니다.

CodeStream은 이러한 상황을 인식하고 코드 블록의 원래 버전(예: 코드마크가 생성된 시점), 현재 버전 및 diff를 포함합니다.

CodeStream을 사용하면 편집기에 방금 입력하고 아직 커밋하지 않은 코드라도 언제든지 소스 파일의 모든 코드 행에 대해 논의할 수 있습니다. CodeStream을 사용하면 개발 프로세스의 가장 초기 단계에서 코드에 대해 논의할 수 있습니다.

코드마크 해결

필수는 아니지만 주석 및 문제 코드마크를 모두 해결할 수 있습니다. CodeStream 창의 코드마크 섹션은 코드마크를 열린 섹션, 해결된 섹션 및 아카이브된 섹션으로 나눕니다. 녹색, 보라색 및 회색 아이콘은 이러한 다른 상태를 나타내는 데 사용됩니다. CodeStream 창에 열려 있는/녹색 코드마크가 많이 표시되면 팀원이 아직 해결되지 않은 토론 및 문제로 인해 차단되고 있음을 의미합니다.

코드마크를 해결하는 동시에 주석을 추가할 수 있으며 동시에 코드마크를 보관할 수도 있습니다.

고급 기능

고급 기능에는 여러 범위의 코드마크, 첨부 파일, 태그 및 관련 코드마크가 포함됩니다.

여러 범위

코드에 대한 많은 토론은 하나 이상의 코드 블록과 관련이 있으며 개념은 한 번에 여러 코드 위치를 참조할 수 있을 때 가장 잘 표현되는 경우가 많습니다. 다음은 작업 중인 다중 범위 코드마크의 몇 가지 예입니다.

• 이름에 영향을 줄 기능의 변경을 고려 중입니다. 이제 함수 호출의 각 인스턴스를 하나의 토론에서 참조할 수 있습니다.
• React 구성 요소와 CSS 스타일이 제대로 상호 작용하지 않으며 팀에 입력을 요청하려고 합니다. 적용해야 한다고 생각하는 div 및 CSS 규칙을 선택할 수 있으므로 팀원이 귀하가 말하는 내용을 정확히 알 수 있습니다.
• 서버에 대한 API 호출을 수행하는 클라이언트는 예기치 않은 결과를 얻을 수 있습니다. API 호출을 수행하는 코드와 API 서버의 핸들러를 선택하여 두 작업을 함께 연결합니다.

다중 범위 코드마크를 생성하려면 + 코드 블록 추가 를 클릭합니다.

그런 다음 동일한 파일, 다른 파일 또는 다른 리포지토리에서 다른 코드 블록을 선택합니다.

다음 예와 같이 각 코드 블록을 [#N] (또는 코드 블록 중 하나에서 핀 아이콘을 클릭하여 마크다운을 삽입)을 참조하여 게시물에 다른 코드 블록을 배치할 수 있습니다.

다음은 해당 예제가 렌더링되는 방법입니다.

코드마크를 생성한 후에는 각 코드 블록의 오른쪽 하단에 있는 점프 아이콘을 클릭하여 다른 위치 사이를 이동할 수 있습니다.

코드마크를 편집할 때 코드 블록을 추가 및 제거할 수 있으며 점선 사각형 아이콘을 클릭하여 코드 블록의 위치를 변경할 수 있습니다.

첨부파일

파일을 코드 블록에 직접 첨부하여 코드에 대한 토론을 풍부하게 합니다. 다음을 첨부할 때 귀하의 주석과 문서가 얼마나 더 설득력이 있는지 생각해 보십시오.

• 새로운 기능의 개발을 안내하는 사양입니다.
• 코드의 문제를 디버그하는 데 도움이 되는 로그 파일입니다.
• 일부 UI 작업을 명확히 하는 데 도움이 되는 모형입니다.
• 문제를 강조하는 스크린샷.

코드 주석 또는 문제를 생성할 때 설명 필드에 끌어다 놓거나 클립보드에서 붙여넣거나 클립 아이콘을 클릭하여 파일을 첨부할 수 있습니다.

마크다운을 사용하여 이미지를 인라인으로 표시할 수도 있습니다. 첨부 파일 오른쪽에 있는 핀 아이콘을 클릭하면 CodeStream이 마크다운을 삽입합니다.

이제 팀원이 원하는 것이 무엇인지 정확히 알고 있습니다.

첨부 파일 섹션에서 파일을 클릭하여 다운로드하거나 적절한 응용 프로그램에서 열 수 있습니다.

태그 추가

코드마크 작성 상자 안에 있는 태그 아이콘을 찾아 태그를 선택하거나 색상과 텍스트 레이블의 조합을 사용하여 태그를 만듭니다.

태그는 조직의 코드마크와 무한한 가능성을 광범위하게 구성하고 그룹화하는 좋은 방법입니다.

필터 및 검색 페이지 에서 태그로 필터링할 수도 있습니다.

관련 코드마크

코드마크 작성 양식에서 CodeStream 아이콘을 클릭하여 현재 코드마크에 첨부할 다른 관련 코드마크를 선택합니다. 이것은 코드베이스의 다른 부분 사이에 연결을 설정합니다. 예를 들어, 코드베이스의 한 부분에 대한 변경이 다른 부분에 대한 변경을 요구하는 경우 두 개의 관련 코드마크를 생성하여 종속성을 식별합니다.

관련 코드마크를 추가하면 관련 섹션에 표시되며 아무거나 클릭하면 해당 코드마크와 코드의 해당 섹션으로 이동할 수 있습니다.

코드마크 관리

코드마크에 대한 줄임표 메뉴를 클릭하면 코드마크를 관리하는 옵션이 표시됩니다.

• 공유 : 코드마크를 생성할 때 Slack 또는 Teams에 공유하는 것 외에도 나중에 언제든지 공유할 수도 있습니다.
• 팔로우/언팔로우 : 코드마크를 팔로우하면 업데이트 시 알림을 받을 수 있습니다. 알림 수신을 중지하려면 언팔로우하세요.
• 링크 복사 : 코드마크에 대한 퍼머링크 를 얻어 어디서나 공유할 수 있습니다.
• 보관 : 주어진 파일에 영구적으로 표시될 만큼 중요하지 않다고 생각되는 코드마크가 있지만 완전히 삭제하고 싶지 않다면 대신 보관할 수 있습니다. 코드마크 섹션 의 설정을 통해 보관된 모든 코드마크를 쉽게 볼 수 있습니다.
• 편집 : 코드마크 작성자만 편집할 수 있습니다.
• 삭제 : 코드마크 작성자만 삭제할 수 있지만 코드마크에 미래 가치가 없다는 확신이 없으면 삭제하는 대신 보관하는 것이 좋습니다.
• 인라인 주석으로 삽입 : 특정 코드마크가 리포지토리의 일부가 되도록 하려면 이 옵션을 사용하여 인라인 주석으로 추가합니다. 적절한 형식을 선택한 다음 타임스탬프, 응답을 포함할지 또는 주석을 80자로 줄바꿈할지 여부를 지정할 수 있습니다. 인라인 주석으로 추가된 코드마크를 보관하도록 선택할 수도 있습니다.
• 코드 마크 재배치 : 대부분의 경우 코드 마크는 시간이 지남에 따라 파일이 변경됨에 따라 참조하는 코드 블록에 자동으로 연결된 상태로 유지됩니다. 예를 들어 코드 블록을 잘라 파일의 다른 위치에 붙여넣으면 코드마크가 함께 이동합니다. 그러나 CodeStream이 자동으로 처리할 수 없는 몇 가지 시나리오가 있습니다. 예를 들어 코드 블록을 다른 파일에 붙여넣은 경우입니다. 이러한 경우 코드마크 위치 변경 을 통해 코드 블록의 새 위치를 선택하여 코드마크가 제대로 표시되도록 할 수 있습니다.

어디서나 공유할 수 있는 퍼머링크

누군가가 영구 링크를 클릭할 때마다 CodeStream으로 인증한 후 웹을 통해 자동으로 IDE로 리디렉션되고 토론이 자동으로 열립니다. 주석이나 문제의 경우 소스 파일이 열리고 해당 코드 블록으로 스크롤됩니다.

CodeStream은 주로 CodeStream에 액세스하는 데 마지막으로 사용한 IDE를 기반으로 열 IDE를 결정하기 위해 최선을 다합니다. 그러나 언제든지 열려 있던 웹 페이지로 돌아가 사용하려는 IDE를 선택할 수 있습니다. 다음에 동일한 리포지토리와 연결된 토론을 열 때 선택 사항이 기억됩니다.

JetBrains IDE를 사용하는 경우 CodeStream이 IDE에 딥 링크할 수 있도록 Toolbox 앱 을 설치하십시오.

코드 블록에 대한 영구 링크

때로는 코드 블록에 대해 반드시 주석을 달고 싶지는 않지만 대신 팀원과 코드를 쉽게 공유하고 싶을 때가 있습니다. CodeStream의 영구 링크는 파일의 다른 위치로 이동된 경우에도 항상 문제의 코드를 가리키는 살아있는 링크입니다.

편집기에서 코드를 선택한 다음 영구 링크 가져오기 버튼을 클릭하여 해당 코드에 대한 영구 링크를 가져옵니다.

• 코드를 보기 전에 CodeStream 인증이 필요한 비공개 영구 링크를 사용하여 퍼머링크를 퍼블릭으로 할지 프라이빗으로 할지 결정합니다.
• 퍼머링크를 복사하여 코드 블록을 공유하고 싶은 곳에 붙여넣으세요.
• 댓글, 문제 및 피드백 요청과 마찬가지로 누군가 영구 링크를 클릭할 때마다 웹을 통해 자동으로 IDE로 리디렉션되며, 소스 파일이 열리고 해당 코드 블록으로 스크롤됩니다.