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

PrimeVueコントリビューションガイドへようこそ。コントリビュートをご検討いただきありがとうございます。

概要 #

PrimeVueは、さまざまなフレームワークに対応した包括的なUIコンポーネントセットで有名なPrimeTekがメンテナンスする、人気のVue UIライブラリです。PrimeTekは、開発者がより優れたアプリケーションをより迅速に構築できるよう、高品質で汎用性の高い、アクセシブルなUIコンポーネントを提供することに専念しています。

開発セットアップ

まず、GitHubからPrimeVueリポジトリをクローンします。


git clone https://github.com/primefaces/primevue.git
cd primevue

次に、ローカル環境でショーケースを実行します。http://localhost:3000/.


npm run setup
npm run dev

プロジェクト構造

PrimeVueはモノレポアーキテクチャを採用しており、ライブラリはpackagesフォルダーに、Webサイトはapps/showcaseにあります。


- apps
  - showcase                // website
- packages
  - auto-import-resolver    // unplugin resolver
  - core                    // core api
  - icons                   // primeicons as sfc
  - metadata                // list of components and directives
  - nuxt-module             // module for nuxt    
  - primevue                // main package of components and directives
  - themes                  // presets of styled mode

必要なヘルプ #

PrimeVueは、PrimeTekの専門知識とスポンサーシップに支えられたコミュニティ主導のプロジェクトであり、皆様のご支援に感謝いたします。コントリビュートできる分野を以下に示します。

課題トリアージ

以下の方法で課題管理にご協力ください。

  • 報告されたバグの再現
  • 課題の説明の明確化
  • 適切なラベルで課題にタグ付け

プルリクエストの送信

特に、help-neededラベルが付いた課題については、プルリクエストを送信することをお勧めします。

コミュニティサポート

イシュートラッカー、GitHubディスカッション、PrimeLand Discordサーバーに参加して、他のユーザーを支援してください。あなたの専門知識は、他のユーザーが問題を解決し、PrimeVueでのエクスペリエンスを向上させるのに役立ちます。

重要なポイント #

PrimeVueには、デザイントークンとスタイリングに依存するUIキット、プレミアムテンプレート、ブロックなどのアドオンがいくつかあります。新しいプロパティ、イベントの追加、デザイントークンの更新など、コア構造の変更は、一貫性と互換性を確保するためにコアーチームと連絡を取り合う必要があります。

コミュニケーション #

PrimeLand Discordサーバーのコントリビューターチャンネルに参加して、PrimeVueスタッフや他のコントリビューターとつながってください。このチャンネルでは、コントリビュートしたい分野について話し合い、フィードバックを受けることができます。このチャンネルは、コントリビュートしたいすべての人に開かれています。

パスウェイ #

PrimeTekは、コントリビューターとコアーチームで構成される組織構造を提供しています。

コントリビューターロール

一定期間頻繁にコントリビュートした後、コミュニティメンバーにはコントリビューターロールが提供されます。平均して約3か月かかりますが、正確な期間は個人のコミットメントによって異なります。

コミッターロール

コントリビューターがコードベースとPRに積極的に参加している場合、そのロールはコミッターレベルにアップグレードされ、PrimeVueコードベースへの直接コミットアクセスが付与されます。

雇用

PrimeTekはオープンソースコミッターからチームメンバーを採用することを好みます。そのため、ポジションが利用可能になった場合は、フルタイムのポジションが提供される場合があります。

利点 #

PrimeVueにコントリビュートすることには、いくつかの利点があります。オープンソースプロジェクトに参加することで、キャリアが向上し、エキサイティングな機会が開かれます。コントリビューターとコミッターは、チームページに掲載されます。プロフェッショナルとして自分を向上させながら、開発者コミュニティで大きな認知度を得ることができます。

PrimeTekと連絡を取るために、Discordのプライベートコミュニケーションチャンネルに招待されます。さらに、コントリビューターは、プレミアムテンプレート、ブロック、UIキットなどのすべてのPrimeVueアドオンを無料で利用できます。

CLA #

コミュニティメンバーにコントリビューターロールが提供される場合、法的目的のためにコントリビューターライセンス契約（CLA）に署名することが求められます。これは、コントリビューターとPrimeTekの両方を保護するのに役立ちます。

PrimeVue 4.0.7 on Vue 3 by PrimeTek