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.