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

Create Onboarding Component

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

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

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
20/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
php, wordpress

調査の方向性

ファイル、テスト、エントリポイントは指定されていません。まず、framework のプラグイン有効化と設定のフローを調査し、次に、どのオンボーディング要件と再利用可能な UI 要件を具体的な最初のマイルストーンとしてスコープに含められるかを判断してください。Done は、対応するテストを伴う、合意済みで任意の実装スコープとして定義してください。

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

説明

Feature

One aspect of the plugin experience that I think can always be improved is onboarding. That space between when the user clicks "Activate" and has a fully configured plugin has a huge impact on how they perceive the plugin's quality as a whole.

I'd like to introduce some building blocks that plugins can leverage to standardize the post-installation experience and just make things a little more pleasant for new users. The initial items to tackle will be:

Framework the "Welcome" Notice

Add standard "Almost ready! Connect to xyz" and/or "read the docs" notices after activation for plugins to use. Also let these be completely overridden when necessary.

Connection Credentials UI

For plugins that require API communication to function fully. Moved from #130

  • Require action before any other plugin settings are available
  • Credentials need to be explicitly edited to change, separate from other on-page settings inputs. Click an Edit button or link to make changes.
  • Status check/indicator. For APIs that support some type of ping, add a "green light" to let users know that things are a-okay. Possibly also include this in the system status report. {BR 2017-01-12} Even if we don't do a green light, an error notice to double-check credentials would be great. This ZD thread is a perfect example of something that would benefit from a low-impact API ping.
Reusable UI Elements

Create standard settings elements that go beyond WooCommerce's set of inputs.

  • "Sync" buttons + handling
  • Address input set - single setting a la AvaTax
Step-by-step setup?

Maybe a little complex for right now, but down the road it'd be nice to allow plugins to define setup steps, like WooCommerce core's new welcome screen but on the plugin settings page.

All of this should of course be optional, flexible, and not too overbearing as many plugins have their own unique configuration requirements.

主要言語
PHP
スター
146
フォーク
43
PR マージ指標
30日以内にマージされた PR はありません

環境構築

  • Dockerfile・Docker Compose ファイルなし
  • プルリクエストのテンプレートあり
  • コントリビューションガイドなし

はじめの一歩

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

godaddy-wordpress/wc-plugin-framework のほかの issue

godaddy-wordpress/wc-plugin-framework の issue をすべて見る

似ている issue

PHP の issue をもっと見る

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

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