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

[next-major] Remove traces of CamelCase

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

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

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
35/100
issue の種類
リファクタリング
明瞭さ
明確に書かれている
活発さ
停滞
技術スタック
python
領域
api

調査の方向性

issue に示されている Python wrapper の宣言から始め、writer、suggestion、search API に残っている CamelCase 名を見つけます。公開されているそれらのメソッドとパラメーターを snake_case に変更し、関連する命名例外を削除して、次のメジャーリリース前に参照とチェックが新しい API を使用していることを確認します。

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

説明

enhancement good first issue

As libzim uses CamelCase, we sometimes followed the convention to stick to the pure-wrapper way.
Given case is not that important and we don't follow it everywhere (it's become minor overtime), we should just remove the remaining traces and use snake case everywhere.

It's a tiny change but obviously breaks the API so should not be merged until approaching next major release

# writer
    def config_nbworkers(self, nbWorkers: int) -> Self: ...  # noqa: N803
    def set_mainpath(self, mainPath: str) -> Self: ...  # noqa: N803
    def add_redirection(
        self,
        path: str,
        title: str,
        targetPath: str,  # noqa: N803
        hints: dict[Hint, int],
    ) -> None: ...
    def add_alias(
        self,
        path: str,
        title: str,
        targetPath: str,  # noqa: N803
        hints: dict[Hint, int],
    ) -> None: ...
# suggestion
    def getEstimatedMatches(self) -> int: ...  # noqa: N802
# search
    def getEstimatedMatches(self) -> int: ...  # noqa: N802
    def getResults(self, start: int, count: int) -> SearchResultSet: ...  # noqa: N802
主要言語
Python
スター
109
フォーク
29
平均マージ
9日 1時間
マージ済み PR(30日)
1

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

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

はじめの一歩

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

openzim/python-libzim のほかの issue

openzim/python-libzim の issue をすべて見る

似ている issue

Python の issue をもっと見る

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

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