github / github/MVG

Exploration: How to visualize what is where?

Đang mở
#7 6 bình luận 0 reaction 0 người được giao Xem trên GitHub
Ngôn ngữ chính
Không có dữ liệu ngôn ngữ
Star
419
Fork
47
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

When I started reading the MVG I had a bit of a hard time figuring out what is where, and what each file is meant to be used for.

I have some ideas but I don't fully know where I am going with this so rather than sending a PR for it right away, I am exploring the options here.

### Idea 1: Formatting the two main folders in the README slightly differently

The [README](https://github.com/github/MVG/blame/main/README.md#L7) could make it more obvious that the main structure are these two folders.

It could look similar to this:

> There are two folders:
> * **org-docs**: Provides top-level organizational governance and polices for a technical steering committee (TSC).
> * **project-docs**: Provides a template for individual project governance, subject to the polices and oversight of the larger organization.

### Idea 2: Tree structure

Listing the main files in the README would allow to explain where to start, and what the purpose of each file is.

For example:

```
org-docs/
├── ANTITRUST.md - ...
├── CHARTER.md <= Start here
├── CODE-OF-CONDUCT.md - Code of Conduct based on the Contributor Covenant.
├── STEERING-COMMITTEE.md - Lists the voting members of the Steering Committee
└── TRADEMARKS.md - ...

project-docs/
├── CONTRIBUTING.md - ...
├── GOVERNANCE.md <= Start here
├── LICENSE.md - ...
└── MAINTAINERS.md - Lists the Maintainers of the Project
```

Alternatively one could add a new README.md file to each of the folders.
Those would serve as index pages, explaining what each file is meant to be used for.

So much for now. Looking forward to hear your thoughts on this.

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

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

Hướng nghiên cứu

Bắt đầu với README.md và so sánh các cây org-docs và project-docs được liệt kê trong issue. Xem lại cuộc thảo luận về các cách tiếp cận điều hướng được đề xuất; công việc được xem là hoàn tất khi đã quyết định một README hoặc cấu trúc chỉ mục theo từng thư mục, giải thích từng tệp được liệt kê và nên bắt đầu từ đâu.

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

Đánh giá

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.