Skip to content

Latest commit

 

History

History
299 lines (200 loc) · 10.9 KB

CONTRIBUTING.md

File metadata and controls

299 lines (200 loc) · 10.9 KB
Raw

Contributing

Thank you for your interest in helping to improve plate! As a community-led project, we wholeheartedly welcome all kinds of contributions. This includes everything from participating in discussions and improving documentation, to fixing bugs and enhancing features.

This document will provide guidance to help streamline the process and make efficient use of everyone's valuable time.

About this repository

This repository is a monorepo.

Structure

This repository is structured as follows:

apps
└── www
    ├── content
    └── src
        └── app
            ├── components
            └── registry
                └── default
                    ├── example
                    └── plate-ui
packages
└── core
Path Description
apps/www/content The content for the website.
apps/www/src/app The Next.js application for the website.
apps/www/src/components The React components for the website.
apps/www/src/registry The registry for the components.
packages/core The @udecode/plate-core package.

Development

Start by cloning the repository:

git clone git@github.com:udecode/plate.git

Install

yarn install

Build

yarn build

Run a workspace

You can use the turbo --filter=[WORKSPACE] command to start the development process for a workspace.

Examples

  1. To run the platejs.org website:
turbo --filter=www dev
  1. To build the @udecode/plate-core package:
turbo --filter=@udecode/plate-core build

Documentation

The documentation for this project is located in the www workspace. After running yarn build, you can run the documentation locally by running the following command:

yarn dev

Documentation is written using MDX. You can find the documentation files in the apps/www/content/docs directory.

Re-run the following commands on each package update:

turbo --filter=[PACKAGE] build
yarn dev

Components

We use a registry system for developing components. You can find the source code for the components under apps/www/src/registry. The components are organized by styles.

apps
└── www
    └── registry
        ├── default
        │   ├── example
        │   └── plate-ui

When adding or modifying components, please ensure that you update the documentation.

CLI

The @udecode/plate-ui package is a CLI for adding components to your project. You can find the documentation for the CLI here.

Any changes to the CLI should be made in the packages/plate-ui directory. If you can, it would be great if you could add tests for your changes.

Run Linter

We use ESLint as our code linter. To run the linter, use the following command:

yarn lint
# autofix with:
yarn lint:fix

Testing

Run Unit Tests

Tests are written using Jest. You can run all the tests from the root of the repository.

yarn test

There are various modes available for running tests, including --watch, --coverage, and --runInBand. These can be selected from the command line interface or passed to yarn test as specific parameters.

Please ensure that the tests are passing when submitting a pull request. If you're adding new features, please include tests.

Run Playwright Tests

We use Playwright for our end-to-end (e2e) tests in headless browsers. The React app for these tests is located in /apps/e2e-examples.

To install Playwright's browsers and dependencies, use:

yarn install:playwright # first time

To run all tests:

yarn playwright

Release Guide

For those wanting a release, follow this sequence:

  • Commit your changes:
    • Run yarn brl to synchronize the exports and automatically update the index files.
    • Make sure lint, test, and build pass.
  • Open a PR against main and add a changeset.
  • Merge the PR, which will trigger the bot to create a PR release.
  • Review the final changesets.
  • Merge the PR release, and the bot will release the updated packages on npm.

Requests for new features

If you have a request for a new feature, please open a discussion on GitHub. We'll be happy to help you out.

Issues

No software is without bugs. If you encounter a problem, please follow these steps:

  • Look through our issue list to see if the issue already exists.
    • If you find an existing issue that matches yours, please give it a "thumbs-up reaction". This helps us prioritize which issues to address first!
  • If you can't find a match, feel free to create a new issue.

Reproductions

The best way to help us understand and fix your issue is to provide a minimal reproduction of the problem. You can do this using our CodeSandbox.

Responding to questions

The Q&A is a great place to help. If you can answer a question, it will benefit the asker and others who have a similar question. If an issue needs reproduction, you may be able to guide the reporter toward one, or even reproduce it yourself using this technique.

Triaging issues

Once you've helped out on a few issues, you can help label issues and respond to reporters. We use a label scheme to categorize issues:

  • type - bug, feature, dependencies, maintenance.
  • area - plugin:x, plugin:list, plugin:common, ui, etc.
  • status - needs reproduction, etc.

All issues should have a type label. dependencies is for keeping package dependencies up to date and maintenance is a catch-all for any kind of cleanup or refactoring. They should also have one or more area/status labels. We use these labels to filter issues down so we can see all of the issues for a particular area and keep the total number of open issues under control. For more info see searching issues in the GitHub docs.

If an issue is a bug, and it doesn't have a clear reproduction that you have personally confirmed, label it needs reproduction and ask the author to try and create a reproduction, or have a go yourself.

Closing issues

  • Duplicate issues should be closed with a link to the original.
  • Unreproducible issues should be closed if it's not possible to reproduce them. If the reporter drops offline, it is reasonable to wait 2 weeks before closing.
  • **bug**s should be closed when the issue is fixed and released.
  • **feature**s, **maintenance**s, should be closed when released or if the feature is deemed not appropriate.

Pull Requests (PRs)

We welcome all contributions and there are many ways you can help. Before you submit a new PR, please run build, lint and test. Do not submit a PR if tests are failing. If you need help, the best way is to join Plate's Discord and ask in the #contributing channel.

You miss time/knowledge but still want to contribute? Just open a PR or a gist on Discord and we'll try to help.

Reviewing PRs

As a PR submitter, you should reference the issue if there is one, include a short description of what you contributed, and provide instructions for manual testing if it is a code change. If your PR is reviewed as only needing trivial changes and you have commit access, then you can merge the PR after making those changes.

As a PR reviewer, read through the changes and comment on any potential problems. Also, follow the testing instructions and manually test the changes. If the instructions are missing, unclear, or overly complex, request better instructions from the submitter. Unless the PR is a draft, if you approve the review and there are no other required discussions or changes, you should also go ahead and merge the PR.

Guides

How to: Create a Component

  • Create your component in apps/www/src/registry/default/plate-ui
  • Add your component to apps/www/src/registry/registry.ts
  • Run yarn build:registry

To try installing your component locally:

  • cd templates/plate-playground
  • yarn g:plate-ui add <component-name>

How to: Docs

Adding a new value? Here's the process:

  • Create the value in /apps/www/src/lib/plate/demo/values
  • Add your value to /apps/www/src/config/setting-values.ts
  • Add your value to /apps/www/src/lib/plate/demo/values/usePlaygroundValue.ts

Creating a new plugin?

  • Add your plugin to /apps/www/src/config/setting-plugins.ts
  • Add your plugin to /apps/www/src/registry/default/example/playground-demo.tsx

Creating a new document?

  • Create a new mdx file in /apps/www/content/docs
  • Add the new document to /apps/www/src/config/docs.ts

How to: Create a Plate Package

Use the command below and follow the prompts to create a new package:

yarn gen:package

After creating your package, install and build it:

yarn install
yarn build

How to: Server bundle

The main bundle is client-side and is not tested in server environments. In general, a server bundle is necessary when the package has usages depending on slate-react or React. In that case, here is how to create a server bundle:

  • Move all files with server support to /src/shared
  • Move all files without server support to /src/client
  • Create a new entry file in /src/server.ts, export with the following:
export * from './shared/index';
export * from './server/index'; // If needed
  • (Optional) If needed, create server-side versions in /src/server/. For example, withReact in /src/server/withReact is a server-side version of /src/client/withReact
  • Run yarn brl to synchronize the exports
  • Update package.json > exports
"exports": {
  ".": {
    "types": "./dist/index.d.ts",
    "import": "./dist/index.mjs",
    "module": "./dist/index.mjs",
    "require": "./dist/index.js"
  },
  "./server": {
    "types": "./dist/server.d.ts",
    "import": "./dist/server.mjs",
    "module": "./dist/server.mjs",
    "require": "./dist/server.js"
  }
},