rustc-dev-guide 문서 작성하기
rustc-dev-guide에 대한 기여는 언제나 환영하며, rust-lang/rustc-dev-guide 저장소에서 직접 기여하실 수 있습니다. 해당 저장소의 이슈 트래커도 해야 할 일을 찾기에 좋은 곳입니다. 초보자부터 숙련된 컴파일러 개발자까지 모두를 위한 이슈가 있습니다!
몇 가지 유의할 사항은 다음과 같습니다.
-
컴파일러 코드의 특정 부분에 대해 작성할 때는 rustc API 문서의 관련 부분으로 링크하기를 권장합니다.
-
장과 절의 제목에는 문장형 대소문자 표기(sentence case)를 사용하십시오.
-
파일 이름에서 단어를 구분할 때는 대시(
-)를 사용하십시오. -
가이드 내부 링크는
.html링크가 아닌.md상대 링크를 사용해야 합니다. CI가 이를 강제합니다. -
지나치게 긴 줄은 피하고, 의미 단위 줄바꿈(각 문장 뒤에서 줄을 바꾸는 방식)을 사용하십시오. 이렇게 하면 관련 없는 다른 문장의 줄이 다시 배치되지 않으므로 diff를 검토하기가 더 쉬워집니다. 줄 길이에 엄격한 제한은 없으므로, 문장이나 문장의 일부가 같은 줄에서 적절한 끝까지 이어지도록 두십시오.
ci/sembr에 있는 도구를 사용하면 이 작업에 도움이 됩니다. 이 도구의 도움말 출력은 다음 명령으로 확인할 수 있습니다.
cargo run --manifest-path ci/sembr/Cargo.toml -- --help -
가이드에 글을 기여할 때는 독자가 해당 정보를 얼마나 신뢰할 수 있는지 알 수 있도록 시기나 이유, 또는 둘 다를 밝혀 정보의 맥락을 제시해 주십시오. 적절한 양의 맥락을 제공하는 것을 목표로 하고, 다음 내용을 포함하는 것을 고려하십시오.
-
변경은 프로젝트 전반에서 늘 일어나는 일이므로, 글이 오래되었을 수 있는 이유를 “변경” 이외의 것으로 제시하십시오.
-
해당 내용이 추가된 날짜를 밝히십시오. 예를 들어 “현재, …“나 “지금으로서는, …“이라고 쓰는 대신 다음 형식 중 하나로 날짜를 추가하는 것을 고려하십시오.
- Jan 2021
- January 2021
- jan 2021
- january 2021
6개월이 지난 항목을 보여 주는 월간 보고서를 생성하는 CI 액션(
.github/workflows/date-check.yml에 있음)이 있습니다(예시).이 액션이 날짜를 인식할 수 있도록 날짜를 명시하기 전에 특별한 주석을 추가하십시오.
<!-- date-check --> Jul 2026예시:
As of <!-- date-check --> Jul 2026, the foo did the bar.날짜가 렌더링된 출력에 보이지 않아야 하는 경우에는 대신 다음을 사용하십시오.
<!-- date-check: Jul 2026 --> -
변경 과정에 대한 추가 설명이나 정보가 오래되지 않았음을 확인하는 방법을 제공할 수 있는 관련 WG, 추적 이슈,
rustcrustdoc 페이지 등에 대한 링크를 포함하십시오.
-
⚠️ 참고: rustc-dev-guide 변경 사항을 기여할 곳
rustc-dev-guide 변경 사항을 어디에 기여해야 하는지와 그렇게 할 때의 이점에 대한 자세한 내용은 rustc-dev-guide 팀 문서를 참고하십시오.