google/comprehensive-rust

Unify setup instructions

Open

#1,426 建立於 2023年10月25日

在 GitHub 查看
 (3 留言) (0 反應) (1 負責人)Rust (32,954 star) (2,009 fork)batch import
documentationgood first issuehelp wanted

描述

We now have both Formatting and Preparation as places where we explain how to install the necessary tooling. I would suggest that we unify this into a single location (I'm thinking CONTRIBUTING.md) and then point people to that file from both TRANSLATIONS.md and README.md etc.

Originally posted by @mgeisler in https://github.com/google/comprehensive-rust/issues/1394#issuecomment-1778854142

貢獻者指南

技術棧
rust
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
blocked
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Basic familiarity with MarkdownGitHub workflowCLI usage
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
85
研究方向
Review the current setup instructions in CONTRIBUTING.md (https://github.com/google/comprehensive rust/blob/main/CONTRIBUTING.md#formatting) and TRANSLATIONS.md (https://github.com/google/comprehensive rust/blob/main/TRANSLATIONS.md#preparation). The task is to consolidate all tooling installation steps into CONTRIBUTING.md, ensuring no duplication. Then update TRANSLATIONS.md and README.md to reference the new unified section. No coding is required, only documentation edits.