Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Refactor repository structure for easier maintenance

オープン
#414 コメント 8 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
リファクタリング
明瞭さ
おおむね明確
活発さ
停滞
領域
tooling

調査の方向性

まず既存の index.yml とカテゴリディレクトリ配下にある各アプリケーションのマニフェストを読み、次に Bottles クライアントの現在のマニフェストスキャン動作を確認します。提案されている meta.yml、ファイル名から導出される名前とカテゴリ、および Icon、Event、Hidden フィールドを現在の形式と比較します。リポジトリ構造とクライアント動作が移行され、古いクライアントが失敗しない状態になれば完了です。

索引モデルが issue の本文から書いたものです。

説明

As discussed in #413:

Problem:

The index.yml is very often forgotten by people (even core contributors). Some people edit the manifest, some people edit the index, but 50% of the time one of them is forgotten. There's lots of metadata repetition, leading to maintainer and contributor mistakes.

Proposal:

  • Delete: index.yml (almost all of its fields are copy-pasted duplicates of the per-app manifests, causing a maintenance burden)
  • Add: meta.yml with the following contents, to tell Bottles which sub-directories to scan for *.yml manifests:
categories:
- Games
- Software
  • Modify <app name>.yml format as follows:
    • Name: Change this to be the "pretty display name" that used to only exist in the index, such as "GOG Galaxy". This field used to be redundant in the manifest and was always the same name as the manifest file minus the .yml extension (so for example, epicgamestore.yml had a Name: epicgamestore which is pointless and a source of potential typos). So let's instead track that internal "name" via the actual .yml filename, and use the Name field to carry the UI display name.
    • Category: Do not add this to the manifest. Instead, automatically detect it based on the name of the directory the manifest is inside, such as "Games" or "Software". That's one less source of typos.
    • Icon: Add this to the manifest. It's the filename of the icon to display during installation.
    • Event: If it's useful, add it to the manifest. I don't know the purpose. Only a few entries in the index currently have this value, and it's always a filename pointing at an installer file. It may be possible to just remove this entirely. Edit: Include it, I found its purpose and it looks like a great idea: https://github.com/bottlesdevs/programs/issues/414#issuecomment-3061658624
    • Hidden: Add this optional field. If missing, assume false. Otherwise allow the manifest to contain true/false here. If hidden is true, do not display this manifest in the UI. The purpose is to allow an easy way to hide broken manifests without having to manually move them out of the auto-scanned manifest directories.

The scanning process for the client to index all manifests is then as follows:

for category in categories:  # "categories" comes from meta.yml
    category_dir = programs_dir / category  # assumes pathlib.Path
    for manifest_yml in category_dir.glob("*.yml"):
        name = manifest_yml.stem
        # We have now automatically derived the category and manifest name:
        # category: Games
        # name: epicgamestore

        # Now read the manifest YAML file, and immediately skip the manifest
        # if `Hidden` exists and is `true`. Do that check before any other parsing,
        # to avoid trying to parse other possibly-outdated manifest structures.

With this repo structure, maintenance is only a matter of editing/moving a single .yml file per application.

Target: Bottles-Next, or possibly even the current public release. If targeting the current release, a simple migration solution is to put up a dummy index.yml file which is empty, so that outdated Bottles clients won't have any fatal errors and simply don't display any programs at all until the user has updated Bottles.

主要言語
言語のデータがありません
スター
111
フォーク
93
平均マージ
1日 1時間
マージ済み PR(30日)
3

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

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

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

bottlesdevs/programs のほかの issue

bottlesdevs/programs の issue をすべて見る

似ている issue

DevTools の issue をもっと見る

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

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