From 2dc12b1b872177bdd5632d183afd9ec1406df90b Mon Sep 17 00:00:00 2001 From: "Leon.C" <160379708+zichen0116@users.noreply.github.com> Date: Fri, 8 May 2026 09:01:18 +0800 Subject: [PATCH 1/3] docs: add CONTRIBUTING.md --- CONTRIBUTING.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..6a1383aa5 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,30 @@ +# Contributing to free-programming-books + +Thank you for your interest in contributing! + +## How to Contribute + +1. Fork the repository +2. Create a feature branch (`git checkout -b feature/your-contribution`) +3. Add your resource to the appropriate list +4. Ensure alphabetical ordering within sections +5. Commit your changes (`git commit -m 'Add [Resource Name]'`) +6. Push to the branch (`git push origin feature/your-contribution`) +7. Open a Pull Request + +## Guidelines + +- Resources must be free (no paid content) +- Use the format: `[Title](URL) - Description (optional)` +- Check for duplicates before adding +- Keep descriptions concise +- Follow existing formatting and alphabetical ordering + +## Reporting Issues + +Please use GitHub Issues to report broken links or suggest improvements. + +## Code of Conduct + +This project follows a code of conduct. By participating, you agree to +be respectful and constructive in all interactions. From 8c50c01865047c679917b13dcec585aa0eb8a551 Mon Sep 17 00:00:00 2001 From: "Leon.C" <160379708+zichen0116@users.noreply.github.com> Date: Fri, 8 May 2026 09:08:15 +0800 Subject: [PATCH 2/3] docs: update Chinese CONTRIBUTING.md with missing sections Added missing sections from English version: - Example formatting - Adding license note guide - RTL/LTR fixing guide - Time-limited courses/trials --- docs/CONTRIBUTING-zh.md | 60 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) diff --git a/docs/CONTRIBUTING-zh.md b/docs/CONTRIBUTING-zh.md index cb6ffd965..ef8286bc8 100644 --- a/docs/CONTRIBUTING-zh.md +++ b/docs/CONTRIBUTING-zh.md @@ -291,3 +291,63 @@ - 您可以指定多个要检查的文件，使用单个空格分隔每个条目。 - 如果您指定了多个文件，构建的结果将基于最后一个检查的文件的结果。您应该注意，由于这个原因，您可能会得到通过的绿色构建，所以请确保在拉取请求结束时检查构建日志，点击 “Show all checks”->“Details”。 + + +### 示例 + +``` +* [另一本很棒的书](http://example.com/book.html) +* [其他书籍](http://example.com/other.html) +``` + +- 不要在 `]` 和 `(` 之间加空格： + + ```text + 错误 : * [另一本很棒的书] (http://example.com/book.html) + 正确 : * [另一本很棒的书](http://example.com/book.html) + ``` + +- 如果包含作者，请使用 ` - `（前后各一个空格的短横线）： + + ```text + 错误 : * [另一本很棒的书](http://example.com/book.html)- 张三 + 正确 : * [另一本很棒的书](http://example.com/book.html) - 张三 + ``` + +#### 添加许可证说明（分步指南） + +当资源以免费/开放许可证分发时，在格式说明后的括号中添加简短的许可证说明。请按以下步骤操作： + +1. 确认资源页面上的许可证 + - 查找页面底部、"关于"页面或许可证/法律部分 + - 仅对免费/开放内容许可证添加许可证说明（参见上面支持的列表）。不要添加"保留所有权利"等说明 +2. 将许可证字符串规范化为支持的缩写之一 +3. 在 PR 中添加说明，说明您为何认为该资源是免费的 + +### 修复 RTL/LTR linter 错误 + +如果您运行 RTL/LTR Markdown Linter（针对 `*-ar.md`、`*-he.md`、`*-fa.md`、`*-ur.md` 文件）并看到错误或警告： + +- **LTR 词**（如"HTML"、"JavaScript"）出现在 RTL 文本中：在每个 LTR 片段后立即附加 `‏` +- **LTR 符号**（如"C#"、"C++"）：在每个 LTR 符号后立即附加 `‎` + +#### 示例 + +**错误** +```html +
+* [كتاب الأمثلة في R](URL) - John Doe (PDF) +
+``` +**正确** +```html +
+* [كتاب الأمثلة في R‏](URL) - John Doe‏ (PDF) +
+``` + +##### 限时课程和试用 + +- 我们不列出需要在六个月内删除的内容 +- 如果课程有有限的注册期或持续时间，我们不会列出 +- 我们不能列出仅在有限时间内免费的资源 From 6c7fc9615b677af7aeda5a62c49982ca849e8669 Mon Sep 17 00:00:00 2001 From: "Leon.C" <160379708+zichen0116@users.noreply.github.com> Date: Fri, 8 May 2026 10:06:58 +0800 Subject: [PATCH 3/3] Delete CONTRIBUTING.md --- CONTRIBUTING.md | 30 ------------------------------ 1 file changed, 30 deletions(-) delete mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 6a1383aa5..000000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,30 +0,0 @@ -# Contributing to free-programming-books - -Thank you for your interest in contributing! - -## How to Contribute - -1. Fork the repository -2. Create a feature branch (`git checkout -b feature/your-contribution`) -3. Add your resource to the appropriate list -4. Ensure alphabetical ordering within sections -5. Commit your changes (`git commit -m 'Add [Resource Name]'`) -6. Push to the branch (`git push origin feature/your-contribution`) -7. Open a Pull Request - -## Guidelines - -- Resources must be free (no paid content) -- Use the format: `[Title](URL) - Description (optional)` -- Check for duplicates before adding -- Keep descriptions concise -- Follow existing formatting and alphabetical ordering - -## Reporting Issues - -Please use GitHub Issues to report broken links or suggest improvements. - -## Code of Conduct - -This project follows a code of conduct. By participating, you agree to -be respectful and constructive in all interactions.