lsd-rs/lsd

Improve the documentation

Open

#120 建立於 2019年2月9日

在 GitHub 查看
 (1 留言) (2 反應) (0 負責人)Rust (13,400 star) (434 fork)batch import
help wantedkind/enhancement

描述

It would be great to have a FAQ or a Known Issues section into the README. The possible content would be:

  • The terminal related bugs with the icons (#118).
  • How to configure properly the terminal font (#117)
  • Some documentation about the default configuration (#113)
  • The snap without --classic "bug" (#127 )

貢獻者指南

技術棧
rust
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
basic gitfamiliarity with Markdown
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
85
研究方向
First, review the referenced issues #118, #117, #113, and #127 to understand the content that should be included in the FAQ or Known Issues section. Then, examine the current README file at the root of the repository to determine where to add the new section. Consider linking to relevant issues or external resources as needed. The goal is to create a clear, organized section that addresses common problems and configurations.