This project has a Code of Conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

Hi! 👋 We’re excited that you’re interested in contributing! Take a moment to read the following guidelines. And thanks for contributing to Blocks! 👏👌✨

Fork the repo to your personal Github account.

Then clone the repo and install the dependencies.

git clone https://github.com/blocks/blocks
cd blocks
yarn

Then, run the docs site:

yarn start

The docs site includes a demo page which is a great way to get started making changes to the editor itself.

Docs pages themselves are located in src/pages. All types of docs contributions are very welcome!

Before undergoing a substantial to docs or the codebase, please open up an issue to make sure it's a desired change. We don't want you to put in lots of time for something that isn't part of this project's goals.

We're working on formalizing the roadmap for Blocks, to make the path to contributing a little bit clearer.

For now, good places to look at are the issues and the roadmap.

If you're keen on the design side of things there's a Figma project.

Reporting bugs that have not been issued yet also helps!

• How it works: Summary of the editor's architecture.