mirror of
https://github.com/EbookFoundation/free-programming-books.git
synced 2025-08-14 03:54:20 +02:00
docs(howto): Homogenize HowTo's format across translated files (#6724)
* Homogenize HowTo's
- Add H1 header
- `Read this` ... right alignmements
- Split a bit first paragraph to highlight welcome.
- Introduce Pull Request acronym.
- trademarks / typos: GitHub, YouTube, Pull Request
- Update GitHub links urls. `help`/`guides` subdomain was moved to `docs` so now a 301 Redirect is skipped.
- Details block added, with center align. When clicked, the contributor graphs is toggled.
- Some bolds to highlight common resources formating issues (like in CONTRIBUTING)
- Repo name in monospace font
- Re-worded last part of 4th paragraph to explain that no new PR is needed to open if there are linter errors or changes are requested. Now it's more clear, I thought.
Via EbookFoundation/free-programming-books#6590
* Rewording to be more meaningful
* Add H1 header + `Read this` ... aligned to right
Via EbookFoundation/free-programming-books#6590
* remove trailing spaces
* Split a bit first paragraph to highlight welcome.
Via EbookFoundation/free-programming-books#6590
* homogenize `1-2` newlines amount between paragraphs
* Update Github documentation links list
- Update GitHub links urls. `help`/`guides` subdomain was moved to `docs` so now a 301 Redirect is skipped.
- Remove flag emojis from link, perhaps use text in notes format to give accesibility locale context
Via EbookFoundation/free-programming-books#6590
* GitHub trademark typos
* YouTube trademark typos
* `Welcome to fpb!` in bold style
* Repo name backticked in monospace font
(non-translatable)
* reword es-en graph summary
* Add a centered details block with graphs about contributions (users vs. time)
Detail blocks are toggleable sections in GitHub
Provided graphs by apiseven:
- Contributor over time Graph
- Monthly Active Contributors graph
* GitHub trademark typos
* Fix pull request typos and introduce it acronym
* Update Github documentation links list
- Update GitHub links urls. `help`/`guides` subdomain was moved to `docs` so now a 301 Redirect is skipped.
- Remove flag emojis from link, perhaps use text in notes format to give accesibility locale context
The forgot rest addressed on 7ee485bb3b commit
Via EbookFoundation/free-programming-books#6590
* Some bolds to highlight common resources formating issues (like in CONTRIBUTING)
* Fix typos suggested by AhmedElTabarani
Co-authored-by: أحمد الطبراني <eltabaraniahmed@gmail.com>
* Add paragrah from #5351. Need language translation
* New strings translated to `it` Italian
Co-authored-by: ImVector <59611597+LuigiImVector@users.noreply.github.com>
* use languages not countries. `in Egyptian Arabic`
* use languages not countries. `in Algerian Arabic`
* remove notes from details block containing graphs about contributions (users vs. time)
* Fix spanish typos
Co-authored-by: Wonjang Son <sondaniel.88@gmail.com>
* Fix korean typos
Co-authored-by: Wonjang Son <sondaniel.88@gmail.com>
* New strings translated to `ar` Arabic
Co-authored-by: أحمد الطبراني <eltabaraniahmed@gmail.com>
* New strings translated to `fr` French
Co-authored-by: Loic Beylot <loic.beylot@gmail.com>
Co-authored-by: أحمد الطبراني <eltabaraniahmed@gmail.com>
Co-authored-by: ImVector <59611597+LuigiImVector@users.noreply.github.com>
Co-authored-by: Wonjang Son <sondaniel.88@gmail.com>
Co-authored-by: Loic Beylot <loic.beylot@gmail.com>
This commit is contained in:
David Ordás
GitHub
@@ -1,17 +1,34 @@
|
||||
*[阅读本文的其他语言版本](README.md#translations))*
|
||||
# How-To at a glance
|
||||
|
||||
欢迎使用 Free-Programming-Books（免费编程书籍）！我们欢迎新的贡献者；即使是在 Github 上首次提出拉取请求的人。如果您是其中之一，那么以下资源可能会有所帮助：
|
||||
<div align="right" markdown="1">
|
||||
|
||||
* [关于拉取请求](https://docs.github.com/cn/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/about-pull-requests)
|
||||
* [创建拉取请求](https://docs.github.com/cn/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)
|
||||
* [Github Hello World 教程](https://guides.github.com/activities/hello-world/)
|
||||
* [Youtube —— Github 初学者教程](https://www.youtube.com/watch?v=0fKg7e37bQE)
|
||||
* [Youtube —— 如何复刻 GitHub 仓库并提交拉取请求](https://www.youtube.com/watch?v=G1I3HF4YWEw)
|
||||
* [Youtube —— Markdown 速成课程](https://www.youtube.com/watch?v=HUBNt18RFbo)
|
||||
*[阅读本文的其他语言版本](README.md#translations)*
|
||||
|
||||
</div>
|
||||
|
||||
**欢迎使用 `Free-Programming-Books`（*免费编程书籍*）！**
|
||||
|
||||
我们欢迎新的贡献者；即使是在 GitHub 上首次提出 Pull Request (PR) 的人。如果您是其中之一，那么以下资源可能会有所帮助：
|
||||
|
||||
* [关于拉取请求](https://docs.github.com/cn/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)
|
||||
* [创建拉取请求](https://docs.github.com/cn/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)
|
||||
* [GitHub Hello World 教程](https://docs.github.com/cn/get-started/quickstart/hello-world)
|
||||
* [YouTube —— GitHub 初学者教程](https://www.youtube.com/watch?v=0fKg7e37bQE) *(用英语)*
|
||||
* [YouTube —— 如何复刻 GitHub 仓库并提交拉取请求](https://www.youtube.com/watch?v=G1I3HF4YWEw) *(用英语)*
|
||||
* [YouTube —— Markdown 速成课程](https://www.youtube.com/watch?v=HUBNt18RFbo) *(用英语)*
|
||||
|
||||
|
||||
不要犹豫，提问题。每个贡献者都从第一个拉取请求开始。你可能是我们的千分之一！
|
||||
不要犹豫，提问题。每个贡献者都从第一个 PR 开始。你可能是我们的千分之一！ So... why not join our [large, growing](https://www.apiseven.com/en/contributor-graph?chart=contributorOverTime&repo=ebookfoundation/free-programming-books) community.
|
||||
|
||||
即使您是经验丰富的开源贡献者，也有一些事情可能会让您绊倒。提交您的拉取请求后，GitHub Actions 会运行一个 linter（代码风格检测工具），经常发现间距或字母顺序方面的小问题。如果您获得绿色按钮，则说明一切准备就绪，但如果没有，请单击 "更多" 链接以查找 linter 不满意的地方。解决此问题并新增 commit 到您的拉取请求。
|
||||
<details align="center" markdown="1">
|
||||
<summary>Click to see the growth users vs. time graphs.</summary>
|
||||
|
||||
最后，如果不确定要添加的资源是否适用于 Free-Programming-Books（免费编程书籍），请通读 [CONTRIBUTING](CONTRIBUTING-zh.md) 中的基本准则。([translations](README.md#translations))
|
||||
[](https://www.apiseven.com/en/contributor-graph?chart=contributorOverTime&repo=ebookfoundation/free-programming-books)
|
||||
|
||||
[](https://www.apiseven.com/en/contributor-graph?chart=contributorMonthlyActivity&repo=ebookfoundation/free-programming-books)
|
||||
|
||||
</details>
|
||||
|
||||
即使您是经验丰富的开源贡献者，也有一些事情可能会让您绊倒。提交您的 PR 后，***GitHub Actions* 会运行一个 *linter*（代码风格检测工具），经常发现间距或字母顺序方面的小问题**。如果您获得绿色按钮，则说明一切准备就绪，但如果没有，请单击 "更多" 链接以查找 linter 不满意的地方。解决此问题并新增 commit 到您的 PR。
|
||||
|
||||
最后，如果不确定要添加的资源是否适用于 `Free-Programming-Books`（免费编程书籍），请通读 [CONTRIBUTING](CONTRIBUTING-zh.md) 中的基本准则。([translations](README.md#translations))
|
||||
|
||||
Reference in New Issue
Block a user