Athena
Home
Environments
Environments
  • Development Server
  • Production
Home
Environments
Environments
  • Development Server
  • Production
  1. Developers
  • Getting Started
    • Start Guide
  • Installation & Setup
    • Windows
  • Architecture
  • Guide
    • Bundles
      • Backend
    • Permissions
      • Frontend
    • Developers
      • Commit Lint
      • RESTful API
    • Workflows
      • Workflow Variables
  • API Reference
    • Authentication
      • Sign In
      • Logout
    • User
      • Get Authenticated User using Multiplai App Access Token
      • Get Authenticated User using Basic Token
    • Workspace
      • Get Workspaces Metrics
      • Get Workspaces
      • Update a Workspace
      • Retrieve a workspace
      • Delete a Workspace
    • Provider
      • Get Providers
      • Retrieve a Provider
      • Update a Provider
      • Create a Provider
      • Delete a Provider
    • Account
      • Get Accounts
      • Update an Account
      • Create an Account
      • Delete an Account
      • Retrieve an Account
    • Agent
      • Get Agents
      • Update an Agent
      • Create an Agent
      • Delete an Agent
      • Retrieve an Agent
      • Run an Agent
      • Train an Agent
      • Generate an Agent
      • Share Agent
      • Get Agent Leaderboard
    • Workflow
      • Get Workflows
      • Create a Workflow
      • Retrieve a Workflow
      • Update a Workflow
      • Delete a Workflow
      • Trigger a webhook
      • Share Workflow
      • Generate Workflow
    • Workflow Execution
      • Get Workflow Executions
      • Get Workflow Execution Counts
      • Retrieve a Workflow Execution
      • Delete a Workflow Execution
    • Prompt
      • Get Prompts
      • Create a Prompt
      • Retrieve a Prompt
      • Update a Prompt
      • Delete a Prompt
      • Run a prompt
    • Memory
      • Get Memories
      • Retrieve a Memory
      • Update a Memory
      • Delete a Memory
    • Thread
      • Get Threads
      • Retrieve a Thread
      • Update a Thread
      • Delete a Thread
      • Create a Thread
      • Run a Thread
      • Generate Thread Name
    • Message
      • Get Messages
      • Retrieve a Message
      • Update a Message
      • Delete a Message
      • Create a Message
    • Large Language Model
      • Get Large Language Models
      • Retrieve a Large Language Model
    • Command Room Task
      • Store Command Room Task
      • Remove Command Room Task
    • Metrics
      • Get Agents Metrics
      • Get Workflows Metrics
      • Get Threads Metrics
      • Get Messages Metrics
      • Get Workflow Executions Metrics
  • Schemas
    • Resources
      • User
      • Workspace
      • Provider
      • Account
      • Agent
      • Workflow
      • Share
      • WorkflowExecution
      • WorkflowExecutionData
      • Prompt
      • Memory
      • Thread
      • Attachment
      • Media
      • Tool
      • Message
      • LargeLanguageModel
      • AgentLeaderboard
    • Utils
      • Pagination
        • PaginationMeta
        • PaginationLinks
      • Provider
        • AuthenticationConfig
      • Profile
        • ProfilePhotoConfig
      • Workflow
        • WorkflowExecutionDataWorkflowData
        • Node
        • Edge
  1. Developers

Commit Lint

Introduction#

This guide provides the coding conventions used in our development process. Adhering to these conventions is vital for maintaining code quality, readability, and consistency across the codebase. We follow the Conventional Commits specification for commit messages, which is instrumental in auto-generating a clear and detailed changelog.

Commit Message Format#

Each commit message should be structured as follows:
<type>(<scope>): <description>
The <type> and <description> fields are mandatory, the optional scope is encouraged for additional context, and the body and footer are optional.

Types#

build: Changes that affect the build system or dependencies (e.g., gulp, npm).
chore: Maintenance changes that don't modify src or test files.
ci: Updates to CI configuration files and scripts (e.g., GitHub Actions workflows).
docs: Documentation-only changes.
feat: Introduces a new feature to the codebase.
fix: Patches a bug in your codebase.
perf: Improvements to code performance.
refactor: Code changes that neither fix a bug nor add a feature.
revert: Reverts a previous commit.
style: Changes that do not affect the meaning of the code (formatting, missing semi-colons, etc).
test: Adds missing tests or corrects existing tests.

Scope#

The scope is optional and should be included if the change affects a specific segment of the codebase. It provides additional contextual information on the commit.

Description#

The description contains a succinct explanation of the change:
Use the imperative, present tense: "change" not "changed" nor "changes".
Do not capitalize the first letter.
No dot (.) at the end.

Examples#

Here are some examples of Conventional Commits:
Introduces a new feature to the codebase.
feat(MAI-001): implement OAuth 2.0
Patches a bug in your codebase.
fix(MAI-002): handle CORS issues
Improvements to code performance.
perf(MAI-003): optimize query performance
Documentation-only changes.
docs(MAI-004): update installation instructions
Changes that do not affect the meaning of the code (formatting, missing semi-colons, etc).
style(MAI-005): run Pint to format code
Adds missing tests or corrects existing tests.
test(MAI-006): add tests for user service

Best Practices#

Write Clear Descriptions: Ensure your commit messages are clear and descriptive of the changes you've made.
Small Commits: Make small, atomic commits that make the commit history easier to understand.
Prefix Appropriately: Use the correct prefix for your commit messages so that the changelog can be accurately generated.
Include Ticket Numbers: If the commit pertains to a particular task or issue, include the ticket number in the commit footer.
Modified at 2026-02-26 23:41:34
Previous
Frontend
Next
RESTful API
Built with