Add contributors guide
Cagatay Civici
parent
44ade4f891
commit
656d63d8a7
|
|
@ -569,6 +569,12 @@
|
|||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Contribution",
|
||||
"to": "/contribution",
|
||||
"icon": "pi pi-users",
|
||||
"badge": "NEW"
|
||||
},
|
||||
{
|
||||
"name": "Discover",
|
||||
"icon": "pi pi-search",
|
||||
|
|
|
|||
|
|
@ -157,8 +157,9 @@
|
|||
top: 50%;
|
||||
transform: translateY(-50%);
|
||||
|
||||
.p-tag-value {
|
||||
.p-tag-label {
|
||||
line-height: 1;
|
||||
font-size: 0.75rem;
|
||||
}
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,9 @@
|
|||
<template>
|
||||
<DocSectionText v-bind="$attrs">
|
||||
<p>
|
||||
Contributing to PrimeVue comes with several benefits. Being part of an open-source project will enhance your career and open up exciting opportunities. Contributors and Committers will be listed on our
|
||||
<NuxtLink to="/team">team page</NuxtLink>. You'll gain significant visibility in the developer community while improving yourself as a professional.
|
||||
</p>
|
||||
<p>You'll be invited to a private communication channel at Discord to get in touch with PrimeTek. In addition, contributors have access to all PrimeVue add-ons like Premium Templates, Blocks, and UI Kit free of charge.</p>
|
||||
</DocSectionText>
|
||||
</template>
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
<template>
|
||||
<DocSectionText v-bind="$attrs">
|
||||
<p>
|
||||
PrimeVue is a popular Vue UI library maintained by PrimeTek, a company renowned for its comprehensive set of UI components for various frameworks. PrimeTek is dedicated to providing high-quality, versatile, and accessible UI components
|
||||
that help developers build better applications faster.
|
||||
</p>
|
||||
</DocSectionText>
|
||||
</template>
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
<template>
|
||||
<DocSectionText v-bind="$attrs">
|
||||
<p>
|
||||
Join the Contributors channel on the PrimeLand Discord server to connect with PrimeVue staff and fellow contributors. In this channel, you can discuss the areas you want to contribute to and receive feedback. This channel is open to
|
||||
everyone who'd like to contribute.
|
||||
</p>
|
||||
</DocSectionText>
|
||||
</template>
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
<template>
|
||||
<DocSectionText v-bind="$attrs">
|
||||
<p>PrimeVue is a community-driven project backed by the expertise and sponsorship of PrimeTek, and we appreciate any help you can provide. Here are some areas where you can contribute:</p>
|
||||
<h3>Issue Triage</h3>
|
||||
<p>Help us manage issues by;</p>
|
||||
<ul class="leading-normal px-10 m-0">
|
||||
<li>Reproducing reported bugs</li>
|
||||
<li>Clarifying issue descriptions</li>
|
||||
<li>Tagging issues with appropriate labels</li>
|
||||
</ul>
|
||||
|
||||
<h3>Sending Pull Requests</h3>
|
||||
<p>We encourage you to send pull requests, especially for issues tagged with the <i>help-needed</i> label.</p>
|
||||
|
||||
<h3>Community Support</h3>
|
||||
<p>Assist other users by participating in the issue tracker, GitHub discussions, and the PrimeLand Discord server. Your expertise can help others solve problems and improve their experience with PrimeVue.</p>
|
||||
</DocSectionText>
|
||||
</template>
|
||||
|
|
@ -0,0 +1,51 @@
|
|||
<template>
|
||||
<DocSectionText v-bind="$attrs">
|
||||
<p>
|
||||
PrimeVue is a popular Vue UI library maintained by PrimeTek, a company renowned for its comprehensive set of UI components for various frameworks. PrimeTek is dedicated to providing high-quality, versatile, and accessible UI components
|
||||
that help developers build better applications faster.
|
||||
</p>
|
||||
<h3>Development Setup</h3>
|
||||
<p>To begin with, clone the PrimeVue repository from GitHub:</p>
|
||||
<DocSectionCode :code="code1" hideToggleCode hideStackBlitz />
|
||||
<p>Then run the showcase in your local environment at <i>http://localhost:3000/</i>.</p>
|
||||
<DocSectionCode :code="code1" hideToggleCode hideStackBlitz />
|
||||
<h3>Project Structure</h3>
|
||||
<p>PrimeVue utilizes a monorepo architecture, the libraries are located at <i>packages</i> folder and the website is at <i>apps/showcase</i>.</p>
|
||||
<DocSectionCode :code="code3" hideToggleCode hideStackBlitz />
|
||||
</DocSectionText>
|
||||
</template>
|
||||
|
||||
<script>
|
||||
export default {
|
||||
data() {
|
||||
return {
|
||||
code1: {
|
||||
basic: `
|
||||
git clone https://github.com/primefaces/primevue.git
|
||||
cd primevue
|
||||
`
|
||||
},
|
||||
code2: {
|
||||
basic: `
|
||||
npm run setup
|
||||
npm run dev
|
||||
`
|
||||
},
|
||||
code3: {
|
||||
basic: `
|
||||
- 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
|
||||
`
|
||||
}
|
||||
};
|
||||
}
|
||||
};
|
||||
</script>
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
<template>
|
||||
<DocSectionText v-bind="$attrs">
|
||||
<p>
|
||||
PrimeVue has several add-ons such as UI Kit, Premium Templates, and Blocks that rely on design tokens and styling. Any core structural changes, such as adding new props, events, or updating design tokens, should be communicated with the
|
||||
core team to ensure consistency and compatibility.
|
||||
</p>
|
||||
</DocSectionText>
|
||||
</template>
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<template>
|
||||
<DocSectionText v-bind="$attrs">
|
||||
<p>PrimeTek offers an organization structure involving contributors and the core team:</p>
|
||||
<h3>Contributor Role</h3>
|
||||
<p>After a certain period of frequent contributions, a community member is offered the Contributor role.On average, it may take about three months, but the exact duration can vary depending on the individual commitment.</p>
|
||||
|
||||
<h3>Committer Role</h3>
|
||||
<p>If a contributor actively participates in the codebase and PRs, their role may be upgraded to a Committer level, providing direct commit access to the PrimeVue codebase.</p>
|
||||
|
||||
<h3>Employment</h3>
|
||||
<p>PrimeTek prefers to hire team members from open source committers, so you may be offered a full-time position when a position becomes available.</p>
|
||||
</DocSectionText>
|
||||
</template>
|
||||
|
|
@ -0,0 +1,74 @@
|
|||
<template>
|
||||
<div>
|
||||
<Head>
|
||||
<Title>Contribution - PrimeVue</Title>
|
||||
<Meta name="description" content="Accessible Vue UI Components." />
|
||||
</Head>
|
||||
|
||||
<div class="doc">
|
||||
<div class="doc-main">
|
||||
<div class="doc-intro">
|
||||
<h1>Contribution Guide</h1>
|
||||
<p>Welcome to the PrimeVue Contribution Guide and thank you for considering contributing.</p>
|
||||
</div>
|
||||
<DocSections :docs="docs" />
|
||||
</div>
|
||||
<DocSectionNav :docs="docs" />
|
||||
</div>
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<script>
|
||||
import BenefitsDoc from '@/doc/contribution/BenefitsDoc.vue';
|
||||
import CLADoc from '@/doc/contribution/CLADoc.vue';
|
||||
import CommunicationDoc from '@/doc/contribution/CommunicationDoc.vue';
|
||||
import HelpNeededDoc from '@/doc/contribution/HelpNeededDoc.vue';
|
||||
import IntroductionDoc from '@/doc/contribution/IntroductionDoc.vue';
|
||||
import KeyPointsDoc from '@/doc/contribution/KeyPointsDoc.vue';
|
||||
import PathwayDoc from '@/doc/contribution/PathwayDoc.vue';
|
||||
|
||||
export default {
|
||||
data() {
|
||||
return {
|
||||
checked: false,
|
||||
docs: [
|
||||
{
|
||||
id: 'introduction',
|
||||
label: 'Introduction',
|
||||
component: IntroductionDoc
|
||||
},
|
||||
{
|
||||
id: 'helpneeded',
|
||||
label: 'Help Needed',
|
||||
component: HelpNeededDoc
|
||||
},
|
||||
{
|
||||
id: 'keypoints',
|
||||
label: 'Key Points',
|
||||
component: KeyPointsDoc
|
||||
},
|
||||
{
|
||||
id: 'communication',
|
||||
label: 'Communication',
|
||||
component: CommunicationDoc
|
||||
},
|
||||
{
|
||||
id: 'pathway',
|
||||
label: 'Pathway',
|
||||
component: PathwayDoc
|
||||
},
|
||||
{
|
||||
id: 'benefits',
|
||||
label: 'Benefits',
|
||||
component: BenefitsDoc
|
||||
},
|
||||
{
|
||||
id: 'cla',
|
||||
label: 'CLA',
|
||||
component: CLADoc
|
||||
}
|
||||
]
|
||||
};
|
||||
}
|
||||
};
|
||||
</script>
|
||||
Loading…
Reference in New Issue