Skip to content

Latest commit

 

History

History
181 lines (117 loc) · 4.46 KB

README.md

File metadata and controls

181 lines (117 loc) · 4.46 KB
Raw

⚠️ WIP: This project is being actively worked on.👷

Please see the Contributing Guide below.

Blocks UI Protocol

Blocks UI Protocol: Decentralized UI Software as an NFT

🌎 💽 🤑

Decentralized. UI Software. As NFTs.

Providing an open and decentralized framework for building user interface software that is simple enough for anyone to use.

Filecoin logo IPFS logo Lit Protocol logo Polygon logo

Table of Contents

Blocks UI Protocol Repos

Open the Blocks UI app

✨ Features

  • Marketplace—for consumers to purchase Blocks
  • Editor-for builders to create new Blocks

Marketplace

Blocks can be bought, sold, or licensed through the Blocks UI Marketplace..

Editor

Build your Blocks using the Blocks UI Editor. Drap and drop primitives to compose a Block.

🤝 Contributing

Code changes can fall into the types from the Conventional Commits specification.

Types

Common types according to commitlint-config-conventional (based on the Angular convention) can be:

  • build—changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm).

  • chore—other changes that don’t modify src or test files.

  • ci—changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs).

  • docs—documentation only changes.

  • feat—a new feature.

  • fix—a bug fix.

  • perf—a code change that improves performance.

  • refactor—a code change that neither fixes a bug nor adds a feature.

  • revert—reverts a previous commit.

  • style—changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc).

  • test—adding missing tests or correcting existing tests.

Branches

Branches are created from main and can follow the naming convention below. For common types, see Types.

Convention:

type/description

Example:

feat/add-xyz

Commits

Conventional Commits are enforced using commitlint in a husky pre-commit hook.

Convention:

type(scope?): description  #scope is optional; multiple scopes are supported (current delimiter options: "/", "\" and ",")

Example:

feat: add xyz

Pull Requests

  1. Title

    Titles can follow the naming convention below and match the branch name. For common types, see Types.

    Convention:

    type: description

    Example:

    feat: add xyz

  2. Body

    When creating a new pull request, you will automatically see a template with a checklist in the body.

  3. Reviewers

    Add at least one reviewer.

  4. Labels

    Apply related labels.

Merging Into Main

Always “Squash & merge” your commits into main.

🧐 License

Licensed under the MIT License.

💜 Thanks

Thanks go out to all of the many sponsors.