EN KO

빌드 방법

버그 수정, 새 기능, 문서 개선 등 모든 기여를 환영합니다.

기여 방법

  1. Noir 저장소를 포크합니다.
  2. 브랜치를 생성합니다. 
    git checkout -b your-feature-or-fix-name
  3. 변경 사항을 적용합니다.
  4. 명확한 커밋 메시지와 함께 커밋합니다.
  5. 포크한 저장소에 푸시합니다. 
    git push origin your-feature-or-fix-name
  6. 변경 사항 설명을 포함하여 풀 리퀘스트를 생성합니다.

자세한 가이드라인은 CONTRIBUTING.md를 참조하세요.

개발 환경 설정

Crystal 설치

Noir는 Crystal로 작성되었습니다. 플랫폼에 맞게 설치합니다.

Ubuntu/Debian

curl -fsSL https://crystal-lang.org/install.sh | sudo bash

macOS (Homebrew)

brew install crystal

기타 플랫폼

Crystal 공식 설치 가이드를 참조하세요.

빌드 및 테스트

포크한 저장소를 클론하고, Crystal의 패키지 매니저인 shards로 의존성을 설치합니다.

git clone https://github.com/<YOUR-USERNAME>/noir
cd noir
shards install

빌드하면 ./bin/noir에 바이너리가 생성됩니다.

shards build

벤치마크나 릴리스 비교 시에는 --release 옵션을 함께 사용해 프로덕션 빌드를 만드세요(컴파일은 느리지만 런타임이 2–3배 빠릅니다). 디버그 빌드는 눈에 띄게 느려서 정상적인 빌드가 성능 회귀처럼 보일 수 있습니다.

shards build --release
# 또는 just 레시피 (alias: `just br`)
just build-release

Crystal 내장 테스트 러너로 테스트를 실행합니다.

crystal spec

# 더 자세한 출력을 원한다면
crystal spec -v

린팅

Noir는 Crystal용 정적 분석 도구인 Ameba로 코드 스타일을 검사합니다.

lib/ameba/bin/ameba.cr

자동 수정도 가능합니다.

lib/ameba/bin/ameba.cr --fix

또는 just를 사용합니다.

just fix
Esc