Rust API 가이드라인

이 문서는 Rust 프로그래밍 언어용 API를 설계하고 표현하는 방법에 관한 권장 사항 모음입니다. 이 가이드라인은 주로 Rust 라이브러리 팀이 Rust 표준 라이브러리와 Rust 생태계의 다른 크레이트를 만들며 얻은 경험을 바탕으로 작성했습니다.

이것은 어디까지나 가이드라인일 뿐이며, 그중 일부는 다른 것보다 더 엄격합니다. 어떤 경우에는 모호하며 아직 다듬어지는 중입니다. Rust 크레이트 작성자는 관용적이고 상호 운용 가능한 Rust 라이브러리를 개발할 때 이 가이드라인을 중요한 고려 사항의 모음으로 여기고, 적절하다고 판단하는 대로 활용하십시오. 이 가이드라인은 결코 크레이트 작성자가 반드시 따라야 하는 의무 사항으로 여겨서는 안 됩니다. 다만 이 가이드라인을 잘 따르는 크레이트가 그렇지 않은 크레이트보다 기존 크레이트 생태계와 더 잘 통합된다는 사실을 알게 될 수도 있습니다.

이 책은 두 부분으로 구성되어 있습니다. 하나는 크레이트 리뷰 중에 빠르게 훑어보기에 적합한, 모든 개별 가이드라인을 간결하게 정리한 체크리스트이고, 다른 하나는 가이드라인을 자세히 설명하는 주제별 장입니다.

API 가이드라인에 기여하는 데 관심이 있다면 contributing.md를 확인하고 Gitter 채널에 참여하십시오.