vim-jp / vim-jp/slacklog-generator
コメントを日本語か英語どちらにするかを決める
Open
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 24
- Forks
- 9
- Avg merge
- 21d 5h
- Merged PRs (30d)
- 1
Description
#111 に関連して
いくつか日本語と英語のコメントが混じっているので // 犯人は私です、すいません
golint が求めるコメントの書き方...
- 日本語だとそれに合わせるためのルールが必要で、それを強制するのが面倒
- 英語だと自然に表現できる
参加者的には...
- 日本語読み書きできる人がほとんど
- 英語だと機械翻訳越しの会話になりかねず、下手すれば機械翻訳のライセンス表記をすることまで考えないといけない // 読みはともかく書きは...という人もいるのではという
ということで、私自身は日本語コメント寄りです // エラーメッセージとかは英語でいいと思います
// 英語のほうが小さいコメントとか書きやすいとかいうのはもちろんありますし、英語を日常的に使われてる方にはコストでしかないと思うので、意見募集です
まぁ統一さえされてれば何でもという方が多いかもしれませんが、一応 Issue に挙げておきます
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the discussion in issue #113 and its related issue #111. The work is done when the project has a decided, consistently documented policy for the language used in comments, including how that policy relates to error messages.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- developer-experience
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100