diff --git a/.github/contributing.md b/.github/contributing.md index 2299a30..aa3ec89 100644 --- a/.github/contributing.md +++ b/.github/contributing.md @@ -119,47 +119,31 @@ Items are roughly ordered like so: ### [`awesome-falsehood`](https://github.com/kdeldycke/awesome-falsehood): candidates -Before contributing, make sure the new link you'd like to add is a good -candidate. +Before contributing, make sure the new link you'd like to add is a good candidate. -Here is a non-restrictive list of items which are good candidates for inclusion -in the `awesome-falsehood` list. +Here is a non-restrictive list of items which are good candidates for inclusion in the `awesome-falsehood` list. #### Falsehood articles -Articles following the *falsehood* schema are prime candidates for inclusion in -this awesome list. +Articles following the *falsehood* schema are prime candidates for inclusion in this awesome list. -These articles starts with the hypothesis that developers have a naive and -simple view of a domain. Then proceed to list a set of candid assumptions that -might be held by programmers. Each one is intentionally false, and in their -best form are illustrated with a counter-example. +These articles starts with the hypothesis that developers have a naive and simple view of a domain. Then proceed to list a set of candid assumptions that might be held by programmers. Each one is intentionally false, and in their best form are illustrated with a counter-example. -A list of falsehood is crafted as a progression that is designed to refine -concepts. Having read the whole list of falsehood, the reader should possess a -better overview of a domain while dispelling its myths, point out common -pitfalls and demonstrate its subtleties. +A list of falsehood is crafted as a progression that is designed to refine concepts. Having read the whole list of falsehood, the reader should possess a better overview of a domain while dispelling its myths, point out common pitfalls and demonstrate its subtleties. -*falsehood* articles are, in a sense, a suite of wordy unit-tests covering -extensive edge-cases provided by real-world usage. The world is messy. -Discovering a domain to be much more complex than anticipated will lead to -frustrations. And cause flipping tables `(╯°□°)╯︵ ┻━┻`. This is the sign of a -great candidate for that list! +*falsehood* articles are, in a sense, a suite of wordy unit-tests covering extensive edge-cases provided by real-world usage. The world is messy. Discovering a domain to be much more complex than anticipated will lead to frustrations. And cause flipping tables `(╯°□°)╯︵ ┻━┻`. This is the sign of a great candidate for that list! -Articles featuring items that are applicable to one product (or a service) and -one only can't be considered as generic enough and should be avoided. +Articles featuring items that are applicable to one product (or a service) and one only can't be considered as generic enough and should be avoided. #### Libraries -Programming libraries or modules are good candidates too, if they solve or -reduce the complexities pointed to by *falsehood* articles above. +Programming libraries or modules are good candidates too, if they solve or reduce the complexities pointed to by *falsehood* articles above. That way we can put back tables in place. `┬─┬ ノ( ゜-゜ノ)` #### Data structures -Data models and structures generic enough to cover and address most of the -falsehoods are also welcome in this page. +Data models and structures generic enough to cover and address most of the falsehoods are also welcome in this page. ## FAQ @@ -189,7 +173,7 @@ Which is true. I have no issue replacing the original URL with an alternative archived/cached link if the original is no longer reachable. -Broken URLs are frustrating. We will fix them one by one. Some have been moved to a new domain. Some have completely disappear, so we'll replace them with a `archive.org` link. +Broken URLs are frustrating. We will fix them one by one. Some have been moved to a new domain. Some have completely disappear, so we'll replace them with an [archived link](#url). If you find a broken one, please propose a PR to fix it. Or just report it as an issue and I'll do the work. @@ -203,7 +187,7 @@ There is no rush to pre-emptively archive content. Incentives exists for others - Popular content in this list are naturally archived by users who value them. - Authors who cares about their content, or benefits from the SEO juice this list provides, have an incentive to keep them available at their original URL. -Despites these incentives, there is still a non-zero chance for content to disappear entirely from the web, with no archived copy in `archive.org`. That's not the end of the world. Maybe the content wasn't worth it, and not good for inclusion in the first place. Think of this edge-case as a natural selection process on content, which helps natural curation. +Despites these incentives, there is still a non-zero chance for content to disappear entirely from the web, with no [archived copy](#url). That's not the end of the world. Maybe the content wasn't worth it, and not good for inclusion in the first place. Think of this edge-case as a natural selection process on content, which helps natural curation. ### Why removes inactive GitHub projects? @@ -229,14 +213,17 @@ If your link was rejected, it must have been motivated and explained to the cont Some reasons for rejection, which often overlaps, includes: +- duplicate content +- lack of originality +- rehash of existing content +- no motivation to explain what the new link adds to the existing corpus +- overcrowded section that [does not need more content, but more curation](https://github.com/kdeldycke/awesome-iam/pull/76) +- [not generic enough, or too specific to a single product or company](https://github.com/kdeldycke/awesome-falsehood/pull/31#issuecomment-407667679) +- marketing copy made to juice the list for SEO +- [too much URLs already pointing out to the same commercial domain name](https://github.com/kdeldycke/awesome-iam/pull/179#issuecomment-3023031941) (2 links are enough) +- lack of feedback from the contributor on raised questions - deviance from these contribution guidelines - violation of the [code of conduct](code-of-conduct.md) -- duplicate content -- lack of motivation in what the new link adds to the existing corpus -- lack of originality -- overcrowded section that [needs more curation than additional content](https://github.com/kdeldycke/awesome-iam/pull/76) -- [commercially-sponsored content only proposed for SEO](https://github.com/kdeldycke/awesome-falsehood/pull/31#issuecomment-407667679) -- lack of feedback from the contributor on raised questions ### How can I force a link into the list? diff --git a/.github/contributing.zh.md b/.github/contributing.zh.md index 90186bc..0a65bf1 100644 --- a/.github/contributing.zh.md +++ b/.github/contributing.zh.md @@ -173,7 +173,7 @@ $ npx awesome-lint 如果原始 URL 不再可访问，我不介意用替代的存档/缓存链接替换原始 URL。 -损坏的 URL 令人沮丧。我们会逐一修复它们。有些已经移动到新域名。有些完全消失了，所以我们会用 `archive.org` 链接替换它们。 +损坏的链接令人沮丧。我们会逐一修复它们。有些链接已被移动到新域名，有些则完全消失了，我们将用[存档链接](#url)来替代它们。 如果您发现损坏的链接，请提出 PR 来修复它。或者只是将其报告为问题，我会完成这项工作。 @@ -187,7 +187,7 @@ $ npx awesome-lint - 这个列表中的热门内容自然被重视它们的用户存档。 - 关心自己内容或从这个列表提供的 SEO 价值中受益的作者有动机保持它们在原始 URL 可用。 -尽管有这些激励，内容完全从网络上消失的可能性仍然不为零，在 `archive.org` 中没有存档副本。这不是世界末日。也许内容不值得，首先就不适合包含。将这种边缘情况视为内容的自然选择过程，这有助于自然策展。 +尽管有这些激励措施，内容仍有可能完全从网络上消失，且没有[存档副本](#url)。这也不是世界末日。也许这些内容本来就不值得保留，原本就不适合被收录。可以把这种极端情况看作是内容的自然选择过程，有助于实现自然的内容筛选和整理。 ### 为什么删除不活跃的 GitHub 项目？ @@ -213,14 +213,17 @@ $ npx awesome-lint 拒绝的一些原因，通常重叠，包括： -- 偏离这些贡献指导原则 -- 违反 [行为准则](code-of-conduct.md) -- 重复内容 -- 缺乏关于新链接为现有内容增加什么的动机 +- 内容重复 - 缺乏原创性 -- 过度拥挤的部分 [需要更多策展而不是额外内容](https://github.com/kdeldycke/awesome-iam/pull/76) -- [仅为 SEO 提议的商业赞助内容](https://github.com/kdeldycke/awesome-falsehood/pull/31#issuecomment-407667679) -- 贡献者对提出的问题缺乏反馈 +- 现有内容的简单重复 +- 没有说明新链接对现有资料库有什么新增价值 +- 所在部分内容过于拥挤，[需要的是更好的整理而非添加更多内容](https://github.com/kdeldycke/awesome-iam/pull/76) +- [不够通用，或过于特定于某一产品或公司](https://github.com/kdeldycke/awesome-falsehood/pull/31#issuecomment-407667679) +- 带有营销性质的内容，仅为提升 SEO 而添加 +- [已经有太多链接指向同一个商业域名](https://github.com/kdeldycke/awesome-iam/pull/179#issuecomment-3023031941) （两个链接就足够了） +- 对提出的问题缺乏反馈 +- 偏离了本贡献指南的要求 +- 违反了[行为准则](code-of-conduct.md) ### 我如何强制将链接加入列表？ diff --git a/.github/workflows/autofix.yaml b/.github/workflows/autofix.yaml index 41520ae..580314a 100644 --- a/.github/workflows/autofix.yaml +++ b/.github/workflows/autofix.yaml @@ -10,4 +10,4 @@ name: Autofix jobs: autofix: - uses: kdeldycke/workflows/.github/workflows/autofix.yaml@v4.17.5 \ No newline at end of file + uses: kdeldycke/workflows/.github/workflows/autofix.yaml@v4.17.9 \ No newline at end of file diff --git a/.github/workflows/autolock.yaml b/.github/workflows/autolock.yaml index e0fbec3..f601a1c 100644 --- a/.github/workflows/autolock.yaml +++ b/.github/workflows/autolock.yaml @@ -8,4 +8,4 @@ name: Autolock jobs: autolock: - uses: kdeldycke/workflows/.github/workflows/autolock.yaml@v4.17.5 + uses: kdeldycke/workflows/.github/workflows/autolock.yaml@v4.17.9 diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 9a3f22d..1aa05a2 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -10,4 +10,4 @@ name: Docs jobs: docs: - uses: kdeldycke/workflows/.github/workflows/docs.yaml@v4.17.5 \ No newline at end of file + uses: kdeldycke/workflows/.github/workflows/docs.yaml@v4.17.9 \ No newline at end of file diff --git a/.github/workflows/label-sponsors.yaml b/.github/workflows/label-sponsors.yaml index 687e57d..6d140be 100644 --- a/.github/workflows/label-sponsors.yaml +++ b/.github/workflows/label-sponsors.yaml @@ -11,4 +11,4 @@ name: Label sponsors jobs: label-sponsors: - uses: kdeldycke/workflows/.github/workflows/label-sponsors.yaml@v4.17.5 \ No newline at end of file + uses: kdeldycke/workflows/.github/workflows/label-sponsors.yaml@v4.17.9 \ No newline at end of file diff --git a/.github/workflows/labels.yaml b/.github/workflows/labels.yaml index 4ef994c..c0444b7 100644 --- a/.github/workflows/labels.yaml +++ b/.github/workflows/labels.yaml @@ -8,4 +8,4 @@ name: Labels jobs: labels: - uses: kdeldycke/workflows/.github/workflows/labels.yaml@v4.17.5 \ No newline at end of file + uses: kdeldycke/workflows/.github/workflows/labels.yaml@v4.17.9 \ No newline at end of file diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml index 3691f81..d13f83e 100644 --- a/.github/workflows/lint.yaml +++ b/.github/workflows/lint.yaml @@ -6,4 +6,4 @@ name: Lint jobs: lint: - uses: kdeldycke/workflows/.github/workflows/lint.yaml@v4.17.5 \ No newline at end of file + uses: kdeldycke/workflows/.github/workflows/lint.yaml@v4.17.9 \ No newline at end of file