Development Standards & Contribution Guidelines

This document outlines the coding standards and contribution guidelines for the Dabia project.

Commit Message Convention

We follow the Conventional Commits specification. This helps in creating a clear and structured git history.

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

feat: A new feature
fix: A bug fix
docs: Documentation only changes
style: Changes that do not affect the meaning of the code (formatting, missing semi-colons, etc)
refactor: A code change that neither fixes a bug nor adds a feature
perf: A code change that improves performance
test: Adding missing tests or correcting existing tests
build: Changes that affect the build system or external dependencies
ci: Changes to CI configuration files and scripts
chore: Other changes that don't modify src or test files
revert: Reverts a previous commit

Conciseness: Keep the description (first line) concise. One sentence is usually enough.
Language: All commit messages must be in English.
No Chinese Characters: Do not use Chinese characters in the commit history.
Lowercase: The <type> and <description> should be in lowercase.
Imperative: Use the imperative mood in the description (e.g., "add feature" instead of "added feature").

Language: All code and comments must be in English.
Linting: Ensure code passes linting checks before committing.
Testing: Run all relevant tests before pushing changes. New features should include corresponding tests.