Skip to content
This repository was archived by the owner on Apr 23, 2026. It is now read-only.

TTAAAN/WebProject

Repository files navigation

Contributing Rules


1. Git Workflow

  • Create branches from main.

  • Branch naming:

    • feat/<name>
    • fix/<name>
    • style/<name>
  • Do not push directly to main.

  • Open a Pull Request before merging.

  • Use squash merge.

  • Delete branch after merge.


2. Commit Messages

Format:

<type>(<scope>): <short summary>   # max 50 chars

<optional body wrapped at 72 chars>

<optional footer>

Types:

  • feat, fix, style, refactor, docs, chore, test

Scopes:

  • layout, header, footer, nav, home, about, css, assets

Rules:

Examples:

  • feat(nav): add mobile dropdown menu
  • fix(layout): prevent footer overlap
  • style(css): reindent card component

3. Code Style Standards

3.1 Indentation

  • Use 4 spaces for indentation.
  • Applies to all HTML and CSS files.
  • Follow the project’s .editorconfig.

3.2 File Naming

  • Lowercase and hyphen-separated.

  • No spaces.

  • Examples:

    • about-us.html
    • main-navigation.css

3.3 HTML Rules

  • Use semantic elements (header, nav, main, section, footer).
  • No inline styles.
  • No inline CSS in HTML files.
  • Images must include alt attributes.
  • Keep indentation consistent (4 spaces).

3.4 CSS Naming (BEM)

Use BEM for CSS classes:

  • .block
  • .block__element
  • .block--modifier
  • .block__element--modifier

Rules:

  • Avoid ID selectors for styling.
  • One declaration per line.
  • Keep selectors simple and readable.

4. Definition of Done

Before merging:

  • Code follows BEM.
  • Indentation uses 4 spaces.
  • Commit message follows the format.
  • Pull Request reviewed by at least one teammate.

About

No description, website, or topics provided.

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors