adambard / adambard/learnxinyminutes-docs

Seeking editorial and review guidelines in the README/CONTRIBUTING md

Đang mở
#5,476 0 bình luận 1 reaction 0 người được giao Xem trên GitHub
Ngôn ngữ chính
Markdown
Star
12.3k
Fork
3.7k
Merge trung bình
13 giờ 10 phút
Pull request đã merge (30 ngày)
6

Mô tả

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

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
markdown
Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Cần làm rõ
Mức phù hợp với người mới
25/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.