Internal Events CLI에 기여하기

GitLab Internal Events CLI의 개발 우선순위, UX 스타일 가이드, 디자인 팁, 개발 관행, FAQ를 설명합니다.

CLI의 우선순위 # CLI는 모든 계측 작업의 진입점으로 설계되었으므로, 계측 기능과의 기능 동등성 유지 CLI는 주로 사용자에게 깔끔하고 명확한 UX를 제공하는 역할을 하므로, 성능 및 수동 테스트가 최우선 과제 사용자가 CLI를 사용하지 않기로 선택한 경우에도, danger/specs/파이프라인을 통해 정의 유효성/데이터 무결성/기능 등을 보장 UX 스타일 가이드 및 원칙 # 제너레이터를 사용해야 하는 경우 # Internal Events 제너레이터는 다음을 수행해야 합니다: 메트릭 계측과 관련된 모든 엔지니어링 작업을 위한 원스톱 쇼핑 창구 역할 Internal Events 제너레이터는 다음을 수행해서는 안 됩니다 : 필수로 요구되어서는 안 됨; 사용자는 동일한 작업을 수동으로 수행할 수 있어야 함 사용자에 대한 기대치 # Internal Events 제너레이터는 다음을 수행해야 합니다: 사용자가 실수하지 않도록 보호 주어진 시점에 목표를 달성하기 위해 아직 완료해야 할 작업을 안내 화면에 표시된 정보만을 기반으로 특정 옵션 선택 또는 텍스트 입력의 결과를 안내 Internal Events 제너레이터는 다음을 수행해서는 안 됩니다 : 제너레이터를 실행하기 전에 계측에 대해 미리 알아야 하도록 요구 특정 작업을 완료하기 위해 특정 컨텍스트가 필요한 경우 화면 전환을 요구 대안적인 경로를 제시하지 않고 사용자가 진행하지 못하도록 차단 개발 환경에 대한 기대치 # Internal Events 제너레이터는 다음을 수행해야 합니다: 동일한 작업을 수동으로 수행하는 것보다 빠르게 실행 강제 종료 시 사용자의 환경을 깔끔하고 유효한 상태로 유지 Internal Events 제너레이터는 다음을 수행해서는 안 됩니다 : 잘못된 사용자 생성 콘텐츠가 존재할 때 중단 Rails가 실행 중이어야 하는 조건을 요구 사용을 위해 작동하는 GDK를 요구 사용자와의 기대치 설정 # Internal Events 제너레이터는 다음을 수행해야 합니다: 각 화면 상단에 진행 표시줄과 필요한 단계를 표시 각 플로우를 정의하는 결과 기반 진입점 사용 친근하고 열정적인 톤 사용 사용자에게 정보 전달 # Internal Events 제너레이터는 다음을 수행해야 합니다: 모든 것에 대해 텍스트 레이블과 설명 제공 사용자가 CLI를 종료할 때 항상 InternalEventsCli::Text::FEEDBACK_NOTICE 출력 예시를 사용하여 결과를 설명 Internal Events 제너레이터는 다음을 수행해서는 안 됩니다 : 색상 및 포맷을 정보나 컨텍스트를 전달하는 유일한 수단으로 사용 사용자로부터 정보 수집 # Internal Events 제너레이터는 다음을 수행해야 합니다: 일반 텍스트 입력보다 선택 메뉴를 선호 가능한 경우 기본값으로 자동 완성하거나 이전 선택을 사용하여 정보 유추 가장 일반적인 사용 사례를 첫 번째/가장 쉬운/기본 옵션으로 선택 항상 유효한 모든 옵션을 허용; CLI는 가장 일반적인 사용 사례가 항상 사용된다고 가정해서는 안 됨 Internal Eve