github-tools / github-tools/github

PR templates - support for inputs

オープン
#678 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る
主要言語
JavaScript
スター
3.8k
フォーク
809
PR マージ指標
30日以内にマージされた PR はありません

説明

Hi,

This is a request for a feature:
I'd like to have a possibility to specify a fields, that needs to be/or can be entered easily in a PR template.

For example, I want a developer to link a Jira issue in a PR it is related to (we have it in commit, ideally in each one, but it easier to have it in PR description).

So similarly to simple checkbox, I'd like to have easy way in "Preview" tab for PR authors to enter required inputs.

```markdown
Jira issue: {TODO}
```

Maybe a first version might be as simple as this: the text between `{}` will be replaced (so it will work first time only) on first edit, Maybe someone could extend this for edits.

Also I'd like to have an option to mark it mandatory, for example

```markdown
Jira issue: {*TODO}
```

might be a version for mandatory input, so only draft PR can be created if not filled in.

Thanks!

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

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

調査の方向性

まず、この JavaScript GitHub wrapper における PR-template 処理のエントリーポイントを見つけ、テンプレート入力の動作がここで公開されているのか、それとも GitHub 自体に属するのかを確認します。プレースホルダーの置換、必須フィールド、初回編集、後続の編集がどのように機能すべきかを定義します。完了には、これらの動作について合意された設計とテストが必要です。

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

評価

技術スタック
github, javascript
領域
developer-experience
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
25/100

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

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