adambard / adambard/learnxinyminutes-docs

Seeking editorial and review guidelines in the README/CONTRIBUTING md

未关闭
#5,476 0 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
Markdown
星标
12.3k
派生
3.7k
平均合并
13 小时 10 分钟
30 天内合并 PR
6

描述

Having recently seen one of my own PRs for a new guide rejected and another I was following rejected, is there something that can be added to the contributing guidelines that describes what the site is currently looking for?

There are currently:

* languages
* frameworks
* algorithms
* tools

The README still says, all contributions are welcome: https://github.com/adambard/learnxinyminutes-docs?tab=readme-ov-file#contributing

But even if the contributing page says accepted contributions are up to the BDFL it still helps those who want to build the resource if there is a clear framework to work within. It is only a style guide right now: https://github.com/adambard/learnxinyminutes-docs/blob/master/CONTRIBUTING.md but if reviews don't refer back to any particular point of concern/issue or offer anything constructive feedback wise, it's not really fostering community.

Additionally, as such a respected site and publishing mechanism, maybe there could be some guidance about what to do with a rejection, e.g. fork the repo, host it yourself? Host the single page build yourself? Or maybe there's room to discuss forks of this repo for the underutilized sections, tools/algorithms/frameworks...

贡献指南

打开贡献指南

调研方向

Start by comparing the README's contributing section with CONTRIBUTING.md, especially the existing style guidance and linked review context. Done means the project has an agreed, clear framework describing what contributions are sought, how reviews and rejections should be handled, and what contributors can do next.

由索引模型根据 Issue 内容生成。

评估

技术栈
markdown
领域
documentation
Issue 类型
文档
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
需要澄清
新手友好度
25/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。