Skip to content
Back to skills

Engineering Guidelines

ASecurity

Use when: writing or reviewing C++, public headers, template function visibility, exported API ABI, ATFW_UTIL_SYMBOL_VISIBLE, or ATFW_UTIL_FORCEINLINE.

  • 234 stars
  • 0 votes
  • 0 copies
  • 3 views
  • Added September 3, 2026
designc++gitapi

Works with

  • api

Security analysis

A100/100

Scanned September 3, 2026

npx -y skills add owent/libatbus --skill engineering-guidelines --agent claude-code

Installs into .claude/skills of the current project.

Are you the author of Engineering Guidelines?

Add the live security badge to your README. It updates with every re-scan.

Security grade badge for Engineering Guidelines
[![Security: A — Skills Directory](https://www.skillsdirectory.com/api/skills/owent-engineering-guidelines/badge)](https://www.skillsdirectory.com/skills/owent-engineering-guidelines)

More formats (shields.io, HTML) on the badges page. Keep it an A: scan every change in CI with Pro.

Download with Pro
SKILL.md
---
name: engineering-guidelines
description: "Use when: writing or reviewing C++, public headers, template function visibility, exported API ABI, ATFW_UTIL_SYMBOL_VISIBLE, or ATFW_UTIL_FORCEINLINE."
---

# Engineering Guidelines

Use this skill before writing or reviewing C++ in `libatbus`.

## Header and ABI boundaries

- Classify each interface as public library API or non-exported internal code before choosing a visibility marker.
- Every public non-template API must use `ATBUS_MACRO_API` (or its matching `*_API` macro) on the declaration or
  enclosing type, or use `ATFW_UTIL_FORCEINLINE` for a header definition. Plain/implicit `inline` and `constexpr` alone
  do not satisfy this public-API rule.
- A public template function defined in a header may instead use `ATFW_UTIL_SYMBOL_VISIBLE`: a non-inlined instantiation
  can share one visible copy across linked targets, while an inlined call embeds a per-target copy. Keep the definition
  ODR-identical for every consumer so all copies have identical behavior.
- Keep non-template implementations covered by an export macro in `.cpp` files by default.
- Non-exported internal helpers may use ODR-correct implicit inline, `constexpr`, or intentional plain `inline`.

## Review and validation

- For touched public headers, verify the publication model, template visibility, and ODR-identical definition together.
- Preserve generated protocol code unless its source of truth is in scope.
- Run `clang-format` for changed C++ files and `git diff --check` for the scoped changes.

Attribution

Is this your skill, or is something wrong with this listing? Request removal or report an issue. Author removals are honored within 72 hours.

Comments

Loading comments…

Newsletter

Get the weekly list of safe new skills, and the ones we pulled.