[RFC] Architecture overview

オープン
#2,524 コメント 0 件 リアクション 7 件 担当者 1 名 GitHub で見る

@DimitrisJim がすでに取り組んでいます。

2023年1月1日 から。

評価

この issue はまだ評価されていません。

説明

RFC

Summary

Create an architectural overview of RustPython, to bridge the gap between occasional and core contributors. The document will be kept concise, only containing essential information.

Detailed Explanation

Motivation

For an open-source project in the range of 10k-200k lines of code, it is recommended to create an architecture document next to the readme and the contributing documents. The purpose of composing an overview of the high-level architecture of RustPython is to bridge the gap between occasional and core contributors. A core contributor has a "mental map" of the code, whereas a new contributor doesn't and simply perceives the code as "a sequence of logical chunks".

Example

An example of such an architecture document is that of the rust-analyzer (https://github.com/rust-analyzer/rust-analyzer/blob/master/docs/dev/architecture.md).

Structure

The document would be structured as follows:

  • A short intro on RustPython: what are some of the aims and functionalities the project has.
  • A high-level overview of RustPython: visualize the main components in a diagram and discuss it shortly.
  • Define the entry points of the components listed in the high-level overview. For a new contributor, it can be hard to identify the main entry points of components.
  • Finally, a detailed list of all 'notable' directories present in the repo. With this, a reader should have a better understanding of the contents of all the directories, and would thus hopefully have a better idea of where to start for their issue/bug/feature.

What is your opinion on this? Would you like to see this Architecture.md file added to this open-source project?

主要言語
Rust
スター
22.4k
フォーク
1.5k
平均マージ
15時間 18分
マージ済み PR（30日）
172

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

RustPython/RustPython のほかの issue

RustPython/RustPython の issue をすべて見る

似ている issue

Rust の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。