Skip to content

IQKV/.github

IQKV Foundation Project — GitHub Profile

A small workspace that powers the IQKV GitHub profile and provides optional developer tooling (commit hooks, formatting, and release helpers).

Use this repository to:

  • Maintain the organization profile: content lives under profile/ and renders on the GitHub org page.
  • Standardize commits and formatting: via Husky, Commitlint, Prettier, Stylelint, and lint-staged.
  • Automate releases: helpers are wired for conventional changelogs.

Repository structure

  • profile/ — content for the org profile
    • README.md — main profile content
    • Static-Analysis-and-Code-Quality-Guidelines.md — quality rules and references
  • commitlint.config.js — conventional commit rules
  • package.json — tooling configuration (husky, lint-staged, prettier, etc.)

Prerequisites

  • Node.js ≥ 22.15.0
  • Git

Setup

Install dependencies (local dev tooling only):

npm install

Husky is configured via the prepare script and will auto-install hooks after npm install.

Common scripts

# Run Stylelint over CSS files
pnpm lint

# Check formatting with Prettier
pnpm prettier:check

# Write formatting changes with Prettier
pnpm prettier:write

# Remove local node_modules
pnpm node_modules:cleanup

Commit conventions

This repo uses Conventional Commits and enforces them with Commitlint and Husky.

  • Recommended types: feat, fix, docs, chore, refactor, test, build, ci.
  • Example: feat(profile): add architecture overview section

Optionally use Commitizen for guided commits:

npx cz

Releasing

Changelog generation is configured for conventional commits. If you automate releases, use release-it or semantic-release according to your workflow. See package.json for available plugins.

Editing the organization profile

Update the content in profile/README.md. GitHub will render this on the organization page. For code quality guidance referenced across projects, see:

  • profile/Static-Analysis-and-Code-Quality-Guidelines.md

License

Apache License 2.0 — see LICENSE.

About

README repository.

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Contributors 2

  •  
  •