Skip to content

Commit cc52717

Browse files
kdeldyckekdeldycke
authored andcommitted
[sync] Updates from awesome-template
Signed-off-by: kdeldycke <[email protected]>
1 parent 324ba3b commit cc52717

File tree

8 files changed

+37
-47
lines changed

8 files changed

+37
-47
lines changed

.github/contributing.md

Lines changed: 19 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -119,47 +119,31 @@ Items are roughly ordered like so:
119119

120120
### [`awesome-falsehood`](https://github.com/kdeldycke/awesome-falsehood): candidates
121121

122-
Before contributing, make sure the new link you'd like to add is a good
123-
candidate.
122+
Before contributing, make sure the new link you'd like to add is a good candidate.
124123

125-
Here is a non-restrictive list of items which are good candidates for inclusion
126-
in the `awesome-falsehood` list.
124+
Here is a non-restrictive list of items which are good candidates for inclusion in the `awesome-falsehood` list.
127125

128126
#### Falsehood articles
129127

130-
Articles following the *falsehood* schema are prime candidates for inclusion in
131-
this awesome list.
128+
Articles following the *falsehood* schema are prime candidates for inclusion in this awesome list.
132129

133-
These articles starts with the hypothesis that developers have a naive and
134-
simple view of a domain. Then proceed to list a set of candid assumptions that
135-
might be held by programmers. Each one is intentionally false, and in their
136-
best form are illustrated with a counter-example.
130+
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.
137131

138-
A list of falsehood is crafted as a progression that is designed to refine
139-
concepts. Having read the whole list of falsehood, the reader should possess a
140-
better overview of a domain while dispelling its myths, point out common
141-
pitfalls and demonstrate its subtleties.
132+
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.
142133

143-
*falsehood* articles are, in a sense, a suite of wordy unit-tests covering
144-
extensive edge-cases provided by real-world usage. The world is messy.
145-
Discovering a domain to be much more complex than anticipated will lead to
146-
frustrations. And cause flipping tables `(╯°□°)╯︵ ┻━┻`. This is the sign of a
147-
great candidate for that list!
134+
*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!
148135

149-
Articles featuring items that are applicable to one product (or a service) and
150-
one only can't be considered as generic enough and should be avoided.
136+
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.
151137

152138
#### Libraries
153139

154-
Programming libraries or modules are good candidates too, if they solve or
155-
reduce the complexities pointed to by *falsehood* articles above.
140+
Programming libraries or modules are good candidates too, if they solve or reduce the complexities pointed to by *falsehood* articles above.
156141

157142
That way we can put back tables in place. `┬─┬ ノ( ゜-゜ノ)`
158143

159144
#### Data structures
160145

161-
Data models and structures generic enough to cover and address most of the
162-
falsehoods are also welcome in this page.
146+
Data models and structures generic enough to cover and address most of the falsehoods are also welcome in this page.
163147

164148
## FAQ
165149

@@ -189,7 +173,7 @@ Which is true.
189173

190174
I have no issue replacing the original URL with an alternative archived/cached link if the original is no longer reachable.
191175

192-
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.
176+
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).
193177

194178
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.
195179

@@ -203,7 +187,7 @@ There is no rush to pre-emptively archive content. Incentives exists for others
203187
- Popular content in this list are naturally archived by users who value them.
204188
- 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.
205189

206-
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.
190+
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.
207191

208192
### Why removes inactive GitHub projects?
209193

@@ -229,14 +213,17 @@ If your link was rejected, it must have been motivated and explained to the cont
229213

230214
Some reasons for rejection, which often overlaps, includes:
231215

232-
- deviance from these contribution guidelines
233-
- violation of the [code of conduct](code-of-conduct.md)
234216
- duplicate content
235-
- lack of motivation in what the new link adds to the existing corpus
236217
- lack of originality
237-
- overcrowded section that [needs more curation than additional content](https://github.com/kdeldycke/awesome-iam/pull/76)
238-
- [commercially-sponsored content only proposed for SEO](https://github.com/kdeldycke/awesome-falsehood/pull/31#issuecomment-407667679)
218+
- rehash of existing content
219+
- no motivation to explain what the new link adds to the existing corpus
220+
- overcrowded section that [does not need more content, but more curation](https://github.com/kdeldycke/awesome-iam/pull/76)
221+
- [not generic enough, or too specific to a single product or company](https://github.com/kdeldycke/awesome-falsehood/pull/31#issuecomment-407667679)
222+
- marketing copy made to juice the list for SEO
223+
- [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)
239224
- lack of feedback from the contributor on raised questions
225+
- deviance from these contribution guidelines
226+
- violation of the [code of conduct](code-of-conduct.md)
240227

241228
### How can I force a link into the list?
242229

.github/contributing.zh.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ $ npx awesome-lint
173173

174174
如果原始 URL 不再可访问,我不介意用替代的存档/缓存链接替换原始 URL。
175175

176-
损坏的 URL 令人沮丧。我们会逐一修复它们。有些已经移动到新域名。有些完全消失了,所以我们会用 `archive.org` 链接替换它们
176+
损坏的链接令人沮丧。我们会逐一修复它们。有些链接已被移动到新域名,有些则完全消失了,我们将用[存档链接](#url)来替代它们
177177

178178
如果您发现损坏的链接,请提出 PR 来修复它。或者只是将其报告为问题,我会完成这项工作。
179179

@@ -187,7 +187,7 @@ $ npx awesome-lint
187187
- 这个列表中的热门内容自然被重视它们的用户存档。
188188
- 关心自己内容或从这个列表提供的 SEO 价值中受益的作者有动机保持它们在原始 URL 可用。
189189

190-
尽管有这些激励,内容完全从网络上消失的可能性仍然不为零,在 `archive.org` 中没有存档副本。这不是世界末日。也许内容不值得,首先就不适合包含。将这种边缘情况视为内容的自然选择过程,这有助于自然策展
190+
尽管有这些激励措施,内容仍有可能完全从网络上消失,且没有[存档副本](#url)。这也不是世界末日。也许这些内容本来就不值得保留,原本就不适合被收录。可以把这种极端情况看作是内容的自然选择过程,有助于实现自然的内容筛选和整理
191191

192192
### 为什么删除不活跃的 GitHub 项目?
193193

@@ -213,14 +213,17 @@ $ npx awesome-lint
213213

214214
拒绝的一些原因,通常重叠,包括:
215215

216-
- 偏离这些贡献指导原则
217-
- 违反 [行为准则](code-of-conduct.md)
218-
- 重复内容
219-
- 缺乏关于新链接为现有内容增加什么的动机
216+
- 内容重复
220217
- 缺乏原创性
221-
- 过度拥挤的部分 [需要更多策展而不是额外内容](https://github.com/kdeldycke/awesome-iam/pull/76)
222-
- [仅为 SEO 提议的商业赞助内容](https://github.com/kdeldycke/awesome-falsehood/pull/31#issuecomment-407667679)
223-
- 贡献者对提出的问题缺乏反馈
218+
- 现有内容的简单重复
219+
- 没有说明新链接对现有资料库有什么新增价值
220+
- 所在部分内容过于拥挤,[需要的是更好的整理而非添加更多内容](https://github.com/kdeldycke/awesome-iam/pull/76)
221+
- [不够通用,或过于特定于某一产品或公司](https://github.com/kdeldycke/awesome-falsehood/pull/31#issuecomment-407667679)
222+
- 带有营销性质的内容,仅为提升 SEO 而添加
223+
- [已经有太多链接指向同一个商业域名](https://github.com/kdeldycke/awesome-iam/pull/179#issuecomment-3023031941) (两个链接就足够了)
224+
- 对提出的问题缺乏反馈
225+
- 偏离了本贡献指南的要求
226+
- 违反了[行为准则](code-of-conduct.md)
224227

225228
### 我如何强制将链接加入列表?
226229

.github/workflows/autofix.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ name: Autofix
1010
jobs:
1111

1212
autofix:
13-
uses: kdeldycke/workflows/.github/workflows/[email protected].5
13+
uses: kdeldycke/workflows/.github/workflows/[email protected].9

.github/workflows/autolock.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ name: Autolock
88
jobs:
99

1010
autolock:
11-
uses: kdeldycke/workflows/.github/workflows/[email protected].5
11+
uses: kdeldycke/workflows/.github/workflows/[email protected].9

.github/workflows/docs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ name: Docs
1010
jobs:
1111

1212
docs:
13-
uses: kdeldycke/workflows/.github/workflows/[email protected].5
13+
uses: kdeldycke/workflows/.github/workflows/[email protected].9

.github/workflows/label-sponsors.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@ name: Label sponsors
1111
jobs:
1212

1313
label-sponsors:
14-
uses: kdeldycke/workflows/.github/workflows/[email protected].5
14+
uses: kdeldycke/workflows/.github/workflows/[email protected].9

.github/workflows/labels.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ name: Labels
88
jobs:
99

1010
labels:
11-
uses: kdeldycke/workflows/.github/workflows/[email protected].5
11+
uses: kdeldycke/workflows/.github/workflows/[email protected].9

.github/workflows/lint.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ name: Lint
66
jobs:
77

88
lint:
9-
uses: kdeldycke/workflows/.github/workflows/[email protected].5
9+
uses: kdeldycke/workflows/.github/workflows/[email protected].9

0 commit comments

Comments
 (0)