vim-jp / vim-jp/vital.vim

Where to place experimental changes

Open
#129 6 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

Lingrにて、「devブランチがある方がよいのではないか」「ホイホイpullreqマージしちゃって大丈夫なのか」という議論がありました。

僕の意見は「devブランチ不要。実験的新機能はExperimental. namespace以下に配置。実験的な既存モジュールの書き換えはそのたびにtopic branchをつくる」です。

一般に、devブランチがある方がよいのは、masterブランチが常に安定している必然性があるプロジェクトです。vitalの場合は比較的masterブランチの新規不安定moduleの追加に関しては緩やかでよい、というのが僕の意見です。新しいmoduleが入っても、vitalを利用してるプラギンがVitalizeで利用中moduleをアップデートしたところで、なにも壊れないからです。

masterブランチにある新しいmoduleを試してみようというとき、そのmoduleに高い安定性を期待するかしないか。vital開発者側の立場としては「どの程度期待するかは自己判断でお願いします」で良いと思います。というのも、安定度を高めるためには実際にプラギンから使った上でフィードバックをもらうのが不可欠だと考えるからです。vitalでプラギンに利用可能にすることが、安定度を高めるよりも重要だと思います。

TODO: 汎用目的のdevブランチを作るのと、特定module(複数の場合も)の実験的な大幅な改変のためにtopicブランチを作るのの違いについて、反論があれば僕の意見もここにまとめる

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 by reading the six-comment discussion and comparing the proposed dev-branch, topic-branch, and Experimental namespace approaches. Resolve the open TODO by documenting an agreed branching policy and how experimental modules should be handled; no files or tests are named in the issue.

Written by the indexing model from the issue text.

Assessment

Domain
developer-experience
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.