Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
230 lines (177 loc) · 8.18 KB

CONTRIBUTING.md

File metadata and controls

230 lines (177 loc) · 8.18 KB

Contributing

Thank you for showing interests in contributing to this project. Please follow this guide before contributing to this project.

Don't know where to start?

If you dont know from where to start, check the issue tracker.

Architecture

Yasumu is designed around a modular architecture where core features are implemented as independent packages.

graph TD
    subgraph Shared ["Shared Utilities"]
        Common["@yasumu/common"]
    end

    subgraph Client ["Client Layer"]
        Core["@yasumu/core<br>(Client SDK)"]
    end

    subgraph Bridge ["Bridge Layer"]
        RPC["@yasumu/rpc<br>(PlatformBridge)"]
    end

    subgraph Server ["Backend Layer (@yasumu/tanxium)"]
        Hono["Hono Server"]
        Den["@yasumu/den<br>(DI Framework)"]
        DB[(SQLite + Drizzle)]
    end

    subgraph Storage ["Storage Layer"]
        Schema["@yasumu/schema"]
        Files["File System<br>(.ysl files)"]
    end

    %% Flows
    Core -->|Uses| RPC
    RPC <-->|IPC/HTTP| Hono
    Hono --> Den
    Den --> DB
    DB <-->|Sync| Schema
    Schema <-->|Serialize| Files

    %% Dependencies
    Common -.-> Core
    Common -.-> RPC
    Common -.-> Den
    Common -.-> Schema
Loading

Package Structure

  • @yasumu/common: A shared package that exposes common types and utilities used across the ecosystem.
  • @yasumu/core: The client SDK that defines how Yasumu's data is managed and structured.
  • @yasumu/rpc: Defines external operations and exposes the PlatformBridge interface, allowing @yasumu/core to communicate with the underlying platform (file system, external servers, etc.).
  • @yasumu/tanxium: The backend API running on Yasumu's custom JS/TS runtime. It uses a Hono server and @yasumu/den (a custom NestJS-like dependency injection container and module system) to expose RPC-friendly endpoints. It manages CRUD operations using Drizzle ORM and a local SQLite database powered by node:sqlite, which is then synchronized with the file system.
  • @yasumu/schema: Handles the serialization and deserialization of Yasumu's entities into the plain text .ysl (Yasumu Schema Language) format.

Core features are implemented as independent modules, making it possible to:

  • Add new protocol support without touching the core system
  • Extend the application with plugins
  • Run specific components in different environments
  • Integrate Yasumu into custom developer tooling

This architecture keeps the system maintainable while allowing it to grow organically with new use cases.

Check for existing PRs

Before making a pull request, make sure to check if someone else has already made a PR for that specific topic. Avoid duplicated PRs.

Commits

Follow conventional commits format while committing. Conventional commit dovetails with semver, by describing the features, fixes, and breaking changes made in commit messages. The following specification is adapted from conventionalcommits.org.

The commit message should be structured as follows:

<type>[optional scope]: <description>

[optional body]

[optional footer]
The commit contains the following structural elements, to communicate intent to the consumers of your library:
  1. fix: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in semantic versioning).
  2. feat: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in semantic versioning).
  3. BREAKING CHANGE: a commit that has the text BREAKING CHANGE: at the beginning of its optional body or footer section introduces a breaking API change (correlating with MAJOR in semantic versioning). A BREAKING CHANGE can be part of commits of any type.
  4. Others: commit types other than fix: and feat: are allowed, for example @commitlint/config-conventional (based on the Angular convention) recommends chore:, docs:, style:, refactor:, perf:, test:, and others.

Examples

Commit message with description and breaking change in body

feat: allow provided config object to extend other configs

BREAKING CHANGE: `extends` key in config file is now used for extending other config files

Commit message with optional ! to draw attention to breaking change

chore!: drop Node 6 from testing matrix

BREAKING CHANGE: dropping Node 6 which hits end of life in April

Commit message with no body

docs: correct spelling of CHANGELOG

Commit message with scope

feat(lang): add polish language

Commit message for a fix using an (optional) issue number.

fix: correct minor typos in code

see the issue for details on the typos fixed

closes issue #12

Specification

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119.

  1. Commits MUST be prefixed with a type, which consists of a noun, feat, fix, etc., followed by an OPTIONAL scope, and a REQUIRED terminal colon and space.
  2. The type feat MUST be used when a commit adds a new feature to your application or library.
  3. The type fix MUST be used when a commit represents a bug fix for your application.
  4. A scope MAY be provided after a type. A scope MUST consist of a noun describing a section of the codebase surrounded by parenthesis, e.g., fix(parser):
  5. A description MUST immediately follow the space after the type/scope prefix. The description is a short summary of the code changes, e.g., fix: array parsing issue when multiple spaces were contained in string.
  6. A longer commit body MAY be provided after the short description, providing additional contextual information about the code changes. The body MUST begin one blank line after the description.
  7. A footer of one or more lines MAY be provided one blank line after the body. The footer MUST contain meta-information about the commit, e.g., related pull-requests, reviewers, breaking changes, with one piece of meta-information per-line.
  8. Breaking changes MUST be indicated at the very beginning of the body section, or at the beginning of a line in the footer section. A breaking change MUST consist of the uppercase text BREAKING CHANGE, followed by a colon and a space.
  9. A description MUST be provided after the BREAKING CHANGE:, describing what has changed about the API, e.g., BREAKING CHANGE: environment variables now take precedence over config files.
  10. Types other than feat and fix MAY be used in your commit messages.
  11. The units of information that make up conventional commits MUST NOT be treated as case sensitive by implementors, with the exception of BREAKING CHANGE which MUST be uppercase.
  12. A ! MAY be appended prior to the : in the type/scope prefix, to further draw attention to breaking changes. BREAKING CHANGE: description MUST also be included in the body or footer, along with the ! in the prefix.

Formatting, Linting, Testing

Make sure to properly format the source code, check for linter errors and test the code before pushing.

File Naming

Prefer the use of kebab-case for file naming. Files such as services may append .service to the name (for example: user.service.ts).

Why kebab-case?

  • Readability: Words are clearly separated with hyphens, making file names easier to read at a glance.
  • Consistency: Uniform naming avoids confusion when importing files, especially in case-sensitive file systems.
  • URL & CLI Friendly: Works seamlessly in URLs and command-line operations without needing quotes or escaping spaces.
  • Cross-Platform Safe: Reduces issues with file systems that treat uppercase/lowercase differently.

Using kebab-case consistently helps maintain a clean, professional, and easily navigable project structure.

🎉 Happy coding!