Skip to content

Commit

Permalink
added community overview and CRP
Browse files Browse the repository at this point in the history
  • Loading branch information
harry75369 committed Jul 4, 2024
1 parent 2aad09c commit df86c86
Show file tree
Hide file tree
Showing 6 changed files with 79 additions and 5 deletions.
2 changes: 0 additions & 2 deletions docs/community/contribution-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ We welcome and appreciate your contributions in terms of bug fixes, enhancements

Both core team members and external contributors send pull requests that undergo the same review process. Refer to [GitHub's pull request tutorial](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests) if you encounter any issues.

Upon opening a pull request, you will be prompted to sign a [Contributor License Agreement (CLA)](https://raw.githubusercontent.com/verygoodgraphics/vgg_runtime/main/.github/CLA.md) by leaving a comment as instructed.

### Basic PR Requirements

- Keep each commit atomic, and commit with clear messages.
Expand Down
36 changes: 36 additions & 0 deletions docs/community/contributor-reward-program.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: Contributor Reward Program
sidebar_position: 3
---

:::info[NOTE]
This program only applies to [VGG Runtime](https://github.com/verygoodgraphics/vgg_runtime)
:::

:::warning
This program is a WIP and will be detailed in the future. The essence won't change regardless.
:::

## Why do we need this program?

VGG Runtime is open-sourced under a conditionally free [license](https://verygoodgraphics.com/licenses/LICENSE-latest),
which differs from common open-source licenses and may cause confusion for open-source contributors. Questions like "Am
I working for this commercial project for free?" or "Why do I have to contribute to this commercial project?" may arise.

VGG Contributor Reward Program (CRP) addresses these concerns by sharing profits from the VGG License to well-recognized
VGG community contributors.

## Who is enrolled in this program?

By contributing to VGG Runtime (with at least one PR merged), you are automatically enrolled in this program.

## What criteria must be met for the reward?

You need to be recognized by VGG Group as a core contributor. VGG Group will make a fair judgment.

## How much I can get?

It depends. If zero profit is generated from VGG License, you'll get nothing substantial except for your public
contribution records.

All royalty fees paied to VGG will be published online.
2 changes: 1 addition & 1 deletion docs/community/meetups.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Meetups
sidebar_position: 6
sidebar_position: 5
---

Coming soon!
39 changes: 38 additions & 1 deletion docs/community/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,42 @@ sidebar_label: Overview
sidebar_position: 0
---

Coming soon!
VeryGoodGraphics (VGG) Community is devoted to facilitating the development and adoption of the
VGG Project, including VGG Specs, VGG Runtime, VGG Containers, and other VGG-related technologies.

VGG Community consists of different roles, including core members, contributors, and users.

## As Core Members

VGG Group is a group of people consisting of the core members of the VGG Project. You can learn
more from [VGG Goverance](/community/goverance).

## As Contributors

All developments happen in VGG's GitHub [organization](https://github.com/verygoodgraphics), where
VGG core members and contributors work on the VGG Project together. Any contributor should read the
following before making any contribution to the VGG Project.

- [Contribution Guide](/community/contribution-guide)
- [Code of Conduct](/community/code-of-conduct)

All VGG projects are open-sourced under the MIT license, except for VGG Runtime which is open-sourced
under a conditionally free license. There is an [Contributor Reward Program](/community/contributor-reward-program)
if you would like to contribute to the VGG Runtime.

## As Users

For newcomers willing to learn VGG framework, the following materials might be helpful:

- [Quick Start](/start/overview)
- [FAQ](/start/faq)
- [Examples](examples/overview)

If you are only interested in the vector graphics part, you can explore:

- The open [specification](/specs/overview)
- Illustrations of each [feature](/features/overview)

## Contacts

Members of any role can communicate through the VGG [Discord channel](https://discord.gg/89fFapjfgM). Alternatively, you can follow VGG's [X (Twitter)](https://twitter.com/VGG_Design) account.
3 changes: 3 additions & 0 deletions docs/start/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,3 +84,6 @@ from this license, but rather from SaaS and technical support.
You must pay VGG a 2% royalty only if your VGG-applied product makes more than $10,000 every quarter.
You can read the full [VGG License](https://verygoodgraphics.com/licenses/LICENSE-latest) for more details.

## Who is behind VGG?

VGG is initiated and developed by VGG Group. You can find the core members in the [VGG Goverance](/community/goverance) document.
2 changes: 1 addition & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ const config = {
],
},
{
title: "Community",
title: "Contacts",
items: [
{
label: "Discord",
Expand Down

0 comments on commit df86c86

Please sign in to comment.