vim-jp / vim-jp/vital.vim

テストやドキュメントが不十分なモジュールを Experimental へ移動する提案

Open
#131 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Vim Script
Stars
587
Forks
64
Avg merge
2d 8h
Merged PRs (30d)
1

Description

逆にいうと spec と doc がないモジュールは全て Experimental へ移動するべきですかね…。
この辺りは期限を決めて一度整理するとよいかもしれませんね。

やりましょう! これはこれ単独で別issue立ててほしいです。
#129 から派生。

テストやドキュメントが不十分なモジュールは『実験的なモジュール』と分類し、Experimental へ移動する提案です。
Experimental へと移動することによりユーザも『実験的なモジュール』だとわかりやすいと思います。
逆に製作者側は Experimental であればある程度自由に開発を行う事ができると思います(破壊的変更など。

Experimental へ移動するべきモジュール例
  • テストがない or 不十分
  • ドキュメントがない or 不十分
  • 開発中、実験的なモジュール
  • 新しく作成するモジュール

その他、『こういうモジュールも Experimental へ移動したほうがよい』みたいな意見がもらえると助かります。

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the discussion in issue #129 and inventory the modules that lack sufficient specs or documentation. Gather agreement on the proposed Experimental criteria and identify which modules meet them. Done means the affected modules and the classification rules are explicitly decided and the move plan is recorded.

Written by the indexing model from the issue text.

Assessment

Tech stack
vim
Domain
tooling
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.