bestax

Projects that follow the best practices below can voluntarily self-certify and show that they've achieved an Open Source Security Foundation (OpenSSF) best practices badge.

There is no set of practices that can guarantee that software will never have defects or vulnerabilities; even formal methods can fail if the specifications or assumptions are wrong. Nor is there any set of practices that can guarantee that a project will sustain a healthy and well-functioning development community. However, following best practices can help improve the results of projects. For example, some practices enable multi-person review before release, which can both help find otherwise hard-to-find technical vulnerabilities and help build trust and a desire for repeated interaction among developers from different companies. To earn a badge, all MUST and MUST NOT criteria must be met, all SHOULD criteria must be met OR be unmet with justification, and all SUGGESTED criteria must be met OR unmet (we want them considered at least). If you want to enter justification text as a generic comment, instead of being a rationale that the situation is acceptable, start the text block with '//' followed by a space. Feedback is welcome via the GitHub site as issues or pull requests There is also a mailing list for general discussion.

We gladly provide the information in several locales, however, if there is any conflict or inconsistency between the translations, the English version is the authoritative version.
If this is your project, please show your badge status on your project page! The badge status looks like this: Badge level for project 14361 is passing Here is how to embed it:
You can show your badge status by embedding this in your markdown file:
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/14361/badge)](https://www.bestpractices.dev/projects/14361)
or by embedding this in your HTML:
<a href="https://www.bestpractices.dev/projects/14361"><img src="https://www.bestpractices.dev/projects/14361/badge"></a>


These are the Silver level criteria. You can also view the Passing or Gold level criteria.

Baseline Series: Baseline Level 1 Baseline Level 2 Baseline Level 3

        

 Basics 12/17 ●

  • General

    Note that other projects may use the same name.

    A fully-typed React component library for the Bulma CSS framework. Build modern UIs quickly with reusable, accessible, and customizable Bulma-based React components.

    Please use SPDX license expression format; examples include "Apache-2.0", "BSD-2-Clause", "BSD-3-Clause", "GPL-2.0+", "LGPL-3.0+", "MIT", and "(BSD-2-Clause OR Ruby)". Do not include single quotes or double quotes.
    If there is more than one language, list them as comma-separated values (spaces optional) and sort them from most to least used. If there is a long list, please list at least the first three most common ones. If there is no language (e.g., this is a documentation-only or test-only project), use the single character "-". Please use a conventional capitalization for each language, e.g., "JavaScript".
    The Common Platform Enumeration (CPE) is a structured naming scheme for information technology systems, software, and packages. It is used in a number of systems and databases when reporting vulnerabilities.

  • Prerequisites


    Enough for a badge!

    The project MUST achieve a passing level badge. [achieve_passing]

  • Basic project website content


    Enough for a badge!

    The information on how to contribute MUST include the requirements for acceptable contributions (e.g., a reference to any required coding standard). (URL required) [contribution_requirements]

    Requirements for acceptable contributions are listed at https://github.com/allxsmith/bestax/blob/main/CONTRIBUTING.md#requirements - all tests pass with per-package jest coverage thresholds enforced (99% for bulma-ui, 95%/78% branches elsewhere), ESLint and Prettier pass, TypeScript typecheck passes, Storybook stories for UI changes, docs updated, and Conventional Commit messages enforced by commitlint. The pull request template repeats the checklist: https://github.com/allxsmith/bestax/blob/main/.github/pull_request_template.md


  • Project oversight


    Barely enough for a badge.

    The project SHOULD have a legal mechanism where all developers of non-trivial amounts of project software assert that they are legally authorized to make these contributions. The most common and easily-implemented approach for doing this is by using a Developer Certificate of Origin (DCO), where users add "signed-off-by" in their commits and the project links to the DCO website. However, this MAY be implemented as a Contributor License Agreement (CLA), or other legal mechanism. (URL required) [dco]
    The DCO is the recommended mechanism because it's easy to implement, tracked in the source code, and git directly supports a "signed-off" feature using "commit -s". To be most effective it is best if the project documentation explains what "signed-off" means for that project. A CLA is a legal agreement that defines the terms under which intellectual works have been licensed to an organization or project. A contributor assignment agreement (CAA) is a legal agreement that transfers rights in an intellectual work to another party; projects are not required to have CAAs, since having CAA increases the risk that potential contributors will not contribute, especially if the receiver is a for-profit organization. The Apache Software Foundation CLAs (the individual contributor license and the corporate CLA) are examples of CLAs, for projects which determine that the risks of these kinds of CLAs to the project are less than their benefits.

    The project has no DCO sign-off requirement and no CLA. Contributions are accepted through pull requests under the repository MIT license with no separate assertion of legal authorization. Closing this would mean enabling DCO sign-off (for example the DCO GitHub App, https://developercertificate.org) as a required check on pull requests, and saying so in CONTRIBUTING.md.


    Not enough for a badge.

    The project MUST clearly define and document its project governance model (the way it makes decisions, including key roles). (URL required) [governance]
    There needs to be some well-established documented way to make decisions and resolve disputes. In small projects, this may be as simple as "the project owner and lead makes all final decisions". There are various governance models, including benevolent dictator and formal meritocracy; for more details, see Governance models. Both centralized (e.g., single-maintainer) and decentralized (e.g., group maintainers) approaches have been successfully used in projects. The governance information does not need to document the possibility of creating a project fork, since that is always possible for FLOSS projects.

    There is no GOVERNANCE.md or equivalent. Decision-making is currently informal: the sole maintainer decides, and the mechanics that surround decisions (branch protection, required review, conventional-commit release rules) are documented in CONTRIBUTING.md and VERSIONING.md, but the governance model itself - who decides what, how disputes are resolved, how someone becomes a maintainer - is not written down.


    Enough for a badge!

    The project MUST adopt a code of conduct and post it in a standard location. (URL required) [code_of_conduct]
    Projects may be able to improve the civility of their community and to set expectations about acceptable conduct by adopting a code of conduct. This can help avoid problems before they occur and make the project a more welcoming place to encourage contributions. This should focus only on behavior within the community/workplace of the project. Example codes of conduct are the Linux kernel code of conduct, the Contributor Covenant Code of Conduct, the Debian Code of Conduct, the Ubuntu Code of Conduct, the Fedora Code of Conduct, the GNOME Code Of Conduct, the KDE Community Code of Conduct, the Python Community Code of Conduct, The Ruby Community Conduct Guideline, and The Rust Code of Conduct.

    The project has adopted a code of conduct in the standard location: https://github.com/allxsmith/bestax/blob/main/CODE_OF_CONDUCT.md It is also surfaced by GitHub in the repository Community profile, and there is a dedicated code-of-conduct-violation issue template for reporting.


    Not enough for a badge.

    The project MUST clearly define and publicly document the key roles in the project and their responsibilities, including any tasks those roles must perform. It MUST be clear who has which role(s), though this might not be documented in the same way. (URL required) [roles_responsibilities]
    The documentation for governance and roles and responsibilities may be in one place.

    Key roles and their responsibilities are not publicly documented. .github/CODEOWNERS records that @allxsmith owns the .github/ security boundary, and CONTRIBUTING.md notes that @claude mentions are maintainer-only, but there is no document defining the roles that exist, what each is responsible for, and who holds them.


    Not enough for a badge.

    The project MUST be able to continue with minimal interruption if any one person dies, is incapacitated, or is otherwise unable or unwilling to continue support of the project. In particular, the project MUST be able to create and close issues, accept proposed changes, and release versions of software, within a week of confirmation of the loss of support from any one individual. This MAY be done by ensuring someone else has any necessary keys, passwords, and legal rights to continue the project. Individuals who run a FLOSS project MAY do this by providing keys in a lockbox and a will providing any needed legal rights (e.g., for DNS names). (URL required) [access_continuity]

    The project is run by a single maintainer who solely holds the GitHub org/repo rights, the npm publishing configuration, and the bestax.io DNS. There is no second person with the access needed to create and close issues, accept changes, and cut a release within a week, and no documented arrangement (lockbox, will, backup owner) covering the loss of that individual.


    Barely enough for a badge.

    The project SHOULD have a "bus factor" of 2 or more. (URL required) [bus_factor]
    A "bus factor" (aka "truck factor") is the minimum number of project members that have to suddenly disappear from a project ("hit by a bus") before the project stalls due to lack of knowledgeable or competent personnel. The truck-factor tool can estimate this for projects on GitHub. For more information, see Assessing the Bus Factor of Git Repositories by Cosentino et al.

    The bus factor is 1. All commits to date are from the sole maintainer (https://github.com/allxsmith/bestax/graphs/contributors); the AI review and implementation automation in this repository speeds the maintainer up but is not a second person who could take over. Raising this to 2 requires adding a second human with commit and release rights.


  • Documentation


    Not enough for a badge.

    The project MUST have a documented roadmap that describes what the project intends to do and not do for at least the next year. (URL required) [documentation_roadmap]
    The project might not achieve the roadmap, and that's fine; the purpose of the roadmap is to help potential users and contributors understand the intended direction of the project. It need not be detailed.

    The project publishes no roadmap covering what it intends to do and not do over the next year. Direction is currently visible only implicitly through open issues and milestones. A ROADMAP.md, or a pinned roadmap issue, would close this.


    Enough for a badge!

    The project MUST include documentation of the architecture (aka high-level design) of the software produced by the project. If the project does not produce software, select "not applicable" (N/A). (URL required) [documentation_architecture]
    A software architecture explains a program's fundamental structures, i.e., the program's major components, the relationships among them, and the key properties of these components and relationships.

    The high-level design is documented in the Library Overview at https://bestax.io/docs/guides/library - the library deliberately mirrors Bulma's own layering (Elements, Components, Form, Layout, Columns, Grid, Helpers) one-to-one, and that section explains the mapping and the shared prop/helper model that every component is built on. The repository structure of the four published packages plus docs is described in https://github.com/allxsmith/bestax/blob/main/CONTRIBUTING.md, and the per-component reference at https://bestax.io/docs/api is generated from the source.


    Not enough for a badge.

    The project MUST document what the user can and cannot expect in terms of security from the software produced by the project (its "security requirements"). (URL required) [documentation_security]
    These are the security requirements that the software is intended to meet.

    https://github.com/allxsmith/bestax/blob/main/SECURITY.md documents the project's own supply-chain posture and how to report a vulnerability, but it does not state the security requirements of the produced software - what a consumer can and cannot expect from it. Closing this means adding a short section saying, for example, that the components render only what the caller passes and rely on React's escaping, that the library performs no network access, no persistence and no cryptography, that any HTML the caller injects is the caller's responsibility, and what the trust boundaries of create-bestax, bestax-migrate and bestax-mcp are.


    Enough for a badge!

    The project MUST provide a "quick start" guide for new users to help them quickly do something with the software. (URL required) [documentation_quick_start]
    The idea is to show users how to get started and make the software do anything at all. This is critically important for potential users to get started.

    There is a quick start at the top of the README (https://github.com/allxsmith/bestax#-quick-start) - one command to scaffold a new app (npm create bestax@latest my-app) or install into an existing one, plus a runnable first component - and an expanded version at https://bestax.io/docs/guides/getting-started/installation. The docs site also has live, editable examples on component pages.


    Enough for a badge!

    The project MUST make an effort to keep the documentation consistent with the current version of the project results (including software produced by the project). Any known documentation defects making it inconsistent MUST be fixed. If the documentation is generally current, but erroneously includes some older information that is no longer true, just treat that as a defect, then track and fix as usual. [documentation_current]
    The documentation MAY include information about differences or changes between versions of the software and/or link to older versions of the documentation. The intent of this criterion is that an effort is made to keep the documentation consistent, not that the documentation must be perfect.

    Documentation is kept current by construction: the API reference is generated from source by pnpm gen:api-docs and CI fails if the committed docs drift from the code (gen:api-docs:check), the same is true of the component catalog and the MCP index, and pnpm check:conformance fails the build when a component lacks its documentation sections or stories. CONTRIBUTING.md requires documentation updates before a pull request is approved, and documentation defects are tracked with the documentation-improvement issue template and fixed like any other bug.


    Enough for a badge!

    The project repository front page and/or website MUST identify and hyperlink to any achievements, including this best practices badge, within 48 hours of public recognition that the achievement has been attained. (URL required) [documentation_achievements]
    An achievement is any set of external criteria that the project has specifically worked to meet, including some badges. This information does not need to be on the project website front page. A project using GitHub can put achievements on the repository front page by adding them to the README file.

    The README front page carries a badge row that identifies and links every achievement the project has attained - OpenSSF Scorecard, npm provenance, Socket.dev, coverage, the security policy - at https://github.com/allxsmith/bestax#readme, and the docs site links the same. The OpenSSF Best Practices badge is being added to the four README badge sections as part of https://github.com/allxsmith/bestax/issues/415, within 48 hours of it being awarded.


  • Accessibility and internationalization


    Enough for a badge!

    The project (both project sites and project results) SHOULD follow accessibility best practices so that persons with disabilities can still participate in the project and use the project results where it is reasonable to do so. [accessibility_best_practices]
    For web applications, see the Web Content Accessibility Guidelines (WCAG 2.0) and its supporting document Understanding WCAG 2.0; see also W3C accessibility information. For GUI applications, consider using the environment-specific accessibility guidelines (such as Gnome, KDE, XFCE, Android, iOS, Mac, and Windows). Some TUI applications (e.g. `ncurses` programs) can do certain things to make themselves more accessible (such as `alpine`'s `force-arrow-cursor` setting). Most command-line applications are fairly accessible as-is. This criterion is often N/A, e.g., for program libraries. Here are some examples of actions to take or issues to consider:
    • Provide text alternatives for any non-text content so that it can be changed into other forms people need, such as large print, braille, speech, symbols or simpler language ( WCAG 2.0 guideline 1.1)
    • Color is not used as the only visual means of conveying information, indicating an action, prompting a response, or distinguishing a visual element. ( WCAG 2.0 guideline 1.4.1)
    • The visual presentation of text and images of text has a contrast ratio of at least 4.5:1, except for large text, incidental text, and logotypes ( WCAG 2.0 guideline 1.4.3)
    • Make all functionality available from a keyboard (WCAG guideline 2.1)
    • A GUI or web-based project SHOULD test with at least one screen-reader on the target platform(s) (e.g. NVDA, Jaws, or WindowEyes on Windows; VoiceOver on Mac & iOS; Orca on Linux/BSD; TalkBack on Android). TUI programs MAY work to reduce overdraw to prevent redundant reading by screen-readers.

    Accessibility is treated as a first-class concern in the produced software: components render semantic Bulma/HTML markup, expose ARIA attributes as typed props (for example Icon's ariaLabel, and role/aria-* passthrough on interactive components), and the docs guides call out the accessible usage of each interactive component. The project also provides a dedicated accessibility-issue template (https://github.com/allxsmith/bestax/blob/main/.github/ISSUE_TEMPLATE/accessibility-issue.md) so accessibility defects are reported and tracked as their own class of bug. The project sites are plain HTML/Docusaurus and GitHub, both keyboard-navigable.


    Enough for a badge!

    The software produced by the project SHOULD be internationalized to enable easy localization for the target audience's culture, region, or language. If internationalization (i18n) does not apply (e.g., the software doesn't generate text intended for end-users and doesn't sort human-readable text), select "not applicable" (N/A). [internationalization]
    Localization "refers to the adaptation of a product, application or document content to meet the language, cultural and other requirements of a specific target market (a locale)." Internationalization is the "design and development of a product, application or document content that enables easy localization for target audiences that vary in culture, region, or language." (See W3C's "Localization vs. Internationalization".) Software meets this criterion simply by being internationalized. No localization for another specific language is required, since once software has been internationalized it's possible for others to work on localization.

    The library does not generate text intended for end users and does not sort human-readable text - every string a user sees comes from the consuming application and is passed in as children or props, so the components are locale-agnostic and work unchanged in any language, including right-to-left, via standard HTML attributes. The only English text the project emits is developer-facing CLI output in create-bestax and bestax-migrate.


  • Other


    Enough for a badge!

    If the project sites (website, repository, and download URLs) store passwords for authentication of external users, the passwords MUST be stored as iterated hashes with a per-user salt by using a key stretching (iterated) algorithm (e.g., Argon2id, Bcrypt, Scrypt, or PBKDF2). If the project sites do not store passwords for this purpose, select "not applicable" (N/A). [sites_password_security]
    Note that the use of GitHub meets this criterion. This criterion only applies to passwords used for authentication of external users into the project sites (aka inbound authentication). If the project sites must log in to other sites (aka outbound authentication), they may need to store authorization tokens for that purpose differently (since storing a hash would be useless). This applies criterion crypto_password_storage to the project sites, similar to sites_https.

    The project sites store no passwords for authentication of external users. The documentation site at https://bestax.io is a statically generated Docusaurus site on Cloudflare Pages with no accounts or login, the repository is hosted on GitHub, and the packages are distributed by the npm registry; authentication for all of those is handled by those providers, not by this project.


 Change Control 1/1 ●

  • Previous versions


    Enough for a badge!

    The project MUST maintain the most often used older versions of the product or provide an upgrade path to newer versions. If the upgrade path is difficult, the project MUST document how to perform the upgrade (e.g., the interfaces that have changed and detailed suggested steps to help upgrade). [maintenance_or_update]

    The project provides a documented upgrade path rather than maintaining old lines. Supported versions are stated explicitly in https://github.com/allxsmith/bestax/blob/main/SECURITY.md (latest release line per package), semantic versioning driven by Conventional Commits means a major bump is the signal that an upgrade needs attention, and every breaking change is recorded with its BREAKING CHANGE note in the per-package CHANGELOG and GitHub Release. Migration guides live at https://bestax.io/docs/guides/getting-started/migration, and the project additionally ships a codemod, bestax-migrate, that performs the mechanical parts of an upgrade automatically.


 Reporting 3/3 ●

  • Bug-reporting process


    Enough for a badge!

    The project MUST use an issue tracker for tracking individual issues. [report_tracker]

    The project uses the GitHub issue tracker for individual issues, with labels, templates and automated triage: https://github.com/allxsmith/bestax/issues


  • Vulnerability report process


    Enough for a badge!

    The project MUST give credit to the reporter(s) of all vulnerability reports resolved in the last 12 months, except for the reporter(s) who request anonymity. If there have been no vulnerabilities resolved in the last 12 months, select "not applicable" (N/A). (URL required) [vulnerability_report_credit]

    No vulnerabilities have been reported or resolved in this project in the last 12 months, so there is no reporter to credit. The published policy commits to crediting reporters in the release notes or advisory unless they request anonymity: https://github.com/allxsmith/bestax/blob/main/SECURITY.md


    Enough for a badge!

    The project MUST have a documented process for responding to vulnerability reports. (URL required) [vulnerability_response_process]
    This is strongly related to vulnerability_report_process, which requires that there be a documented way to report vulnerabilities. It also related to vulnerability_report_response, which requires response to vulnerability reports within a certain time frame.

    The response process is documented at https://github.com/allxsmith/bestax/blob/main/SECURITY.md - reports arrive by email to security@bestax.io or as a GitHub private security advisory; acknowledgement within 48 hours; triage and confirmation within 7 days; if accepted, a fix and a coordinated disclosure timeline agreed with the reporter; if declined, an explanation of why; credit to the reporter unless anonymity is requested; and publication of a GitHub Security Advisory once resolved. Because all packages release automatically from main, the fix ships as soon as it merges.


 Quality 19/19 ●

  • Coding standards


    Enough for a badge!

    The project MUST identify the specific coding style guides for the primary languages it uses, and require that contributions generally comply with it. (URL required) [coding_standards]
    In most cases this is done by referring to some existing style guide(s), possibly listing differences. These style guides can include ways to improve readability and ways to reduce the likelihood of defects (including vulnerabilities). Many programming languages have one or more widely-used style guides. Examples of style guides include Google's style guides and SEI CERT Coding Standards.

    The style guides are identified and required. Formatting is Prettier (the project's Prettier configuration is the style guide of record, and it is pinned so formatting stays deterministic); lint rules are the ESLint flat config at https://github.com/allxsmith/bestax/blob/main/eslint.config.js, composed of eslint:recommended, typescript-eslint, eslint-react, react-hooks, storybook and prettier; commit messages follow Conventional Commits per https://github.com/allxsmith/bestax/blob/main/commitlint.config.js. Compliance is required of contributions by https://github.com/allxsmith/bestax/blob/main/CONTRIBUTING.md#code-quality-standards


    Enough for a badge!

    The project MUST automatically enforce its selected coding style(s) if there is at least one FLOSS tool that can do so in the selected language(s). [coding_standards_enforced]
    This MAY be implemented using static analysis tool(s) and/or by forcing the code through code reformatters. In many cases the tool configuration is included in the project's repository (since different projects may choose different configurations). Projects MAY allow style exceptions (and typically will); where exceptions occur, they MUST be rare and documented in the code at their locations, so that these exceptions can be reviewed and so that tools can automatically handle them in the future. Examples of such tools include ESLint (JavaScript), Rubocop (Ruby), and devtools check (R).

    Enforcement is automatic, not advisory: pnpm lint (ESLint) and pnpm format:check (Prettier) run in CI on every push and pull request and must pass before merge, commitlint runs on the husky commit-msg hook and again on pull request titles, and pnpm check:conformance enforces the additional house conventions. All of these are FLOSS tools.


  • Working build system


    Enough for a badge!

    Build systems for native binaries MUST honor the relevant compiler and linker (environment) variables passed in to them (e.g., CC, CFLAGS, CXX, CXXFLAGS, and LDFLAGS) and pass them to compiler and linker invocations. A build system MAY extend them with additional flags; it MUST NOT simply replace provided values with its own. If no native binaries are being generated, select "not applicable" (N/A). [build_standard_variables]
    It should be easy to enable special build features like Address Sanitizer (ASAN), or to comply with distribution hardening best practices (e.g., by easily turning on compiler flags to do so).

    The project produces no native binaries - all output is JavaScript, TypeScript declarations and CSS - so there are no CC, CFLAGS, CXX, CXXFLAGS or LDFLAGS variables for the build to honor.


    Enough for a badge!

    The build and installation system SHOULD preserve debugging information if they are requested in the relevant flags (e.g., "install -s" is not used). If there is no build or installation system (e.g., typical JavaScript libraries), select "not applicable" (N/A). [build_preserve_debug]
    E.G., setting CFLAGS (C) or CXXFLAGS (C++) should create the relevant debugging information if those languages are used, and they should not be stripped during installation. Debugging information is needed for support and analysis, and also useful for measuring the presence of hardening features in the compiled binaries.

    There is no native compilation and so no debug-symbol option to preserve. The published JavaScript is not stripped of anything a debugger needs, and consumers debug against readable, typed output plus the TypeScript declarations shipped in each package.


    Enough for a badge!

    The build system for the software produced by the project MUST NOT recursively build subdirectories if there are cross-dependencies in the subdirectories. If there is no build or installation system (e.g., typical JavaScript libraries), select "not applicable" (N/A). [build_non_recursive]
    The project build system's internal dependency information needs to be accurate, otherwise, changes to the project may not build correctly. Incorrect builds can lead to defects (including vulnerabilities). A common mistake in large build systems is to use a "recursive build" or "recursive make", that is, a hierarchy of subdirectories containing source files, where each subdirectory is independently built. Unless each subdirectory is fully independent, this is a mistake, because the dependency information is incorrect.

    The build is not a recursive make. It is a single Turborepo task graph over the workspace (pnpm build), which resolves all inter-package dependencies in one pass from the root.


    Enough for a badge!

    The project MUST be able to repeat the process of generating information from source files and get exactly the same bit-for-bit result. If no building occurs (e.g., scripting languages where the source code is used directly instead of being compiled), select "not applicable" (N/A). [build_repeatable]
    GCC and clang users may find the -frandom-seed option useful; in some cases, this can be resolved by forcing some sort order. More suggestions can be found at the reproducible build site.

    Builds are deterministic and repeatable. Dependencies resolve from a committed pnpm lockfile installed with --frozen-lockfile against a pinned pnpm version and a pinned Node major, and the compilers (tsc, Vite/Rollup, Sass) emit output determined only by their inputs and configuration - the generation checks in CI depend on exactly this property: pnpm gen:api-docs:check, gen:catalog:check and gen:mcp:check regenerate artifacts and fail the build on any byte-level difference from what is committed.


  • Installation system


    Enough for a badge!

    The project MUST provide a way to easily install and uninstall the software produced by the project using a commonly-used convention. [installation_common]
    Examples include using a package manager (at the system or language level), "make install/uninstall" (supporting DESTDIR), a container in a standard format, or a virtual machine image in a standard format. The installation and uninstallation process (e.g., its packaging) MAY be implemented by a third party as long as it is FLOSS.

    Installation and removal use the ordinary JavaScript convention: npm install @allxsmith/bestax-bulma (or pnpm/yarn add) to install, npm uninstall to remove, and npm create bestax@latest my-app to scaffold. Nothing is written outside the consuming project's node_modules, and no install scripts run. Documented in the README quick start and at https://bestax.io/docs/guides/getting-started/installation


    Enough for a badge!

    The installation system for end-users MUST honor standard conventions for selecting the location where built artifacts are written to at installation time. For example, if it installs files on a POSIX system it MUST honor the DESTDIR environment variable. If there is no installation system or no standard convention, select "not applicable" (N/A). [installation_standard_variables]

    There is no separate installation system to parameterize - the npm client places packages according to its own standard conventions inside the consuming project, and the project neither writes files elsewhere nor defines an install path, so DESTDIR and similar variables do not apply.


    Enough for a badge!

    The project MUST provide a way for potential developers to quickly install all the project results and support environment necessary to make changes, including the tests and test environment. This MUST be performed with a commonly-used convention. [installation_development_quick]
    This MAY be implemented using a generated container and/or installation script(s). External dependencies would typically be installed by invoking system and/or language package manager(s), per external_dependencies.

    A developer gets the whole workspace running with git clone, pnpm install and pnpm build - all four packages, the docs site and Storybook. The steps, plus how to run the docs site (pnpm docs), Storybook (pnpm storybook), the full CI suite locally (pnpm all) and a throwaway scaffolded app, are documented at https://github.com/allxsmith/bestax/blob/main/CONTRIBUTING.md#setting-up--running-the-project


  • Externally-maintained components


    Enough for a badge!

    The project MUST list external dependencies in a computer-processable way. (URL required) [external_dependencies]
    Typically this is done using the conventions of package manager and/or build system. Note that this helps implement installation_development_quick.

    External dependencies are listed in computer-processable form in the per-package package.json files and resolved exactly by the committed lockfile: https://github.com/allxsmith/bestax/blob/main/pnpm-lock.yaml and https://github.com/allxsmith/bestax/blob/main/bulma-ui/package.json. The library ships a single runtime dependency (Bulma v1); icon libraries are optional peer dependencies. A machine-readable SBOM is additionally generated for every release by https://github.com/allxsmith/bestax/blob/main/.github/workflows/supply-chain.yml


    Enough for a badge!

    Projects MUST monitor or periodically check their external dependencies (including convenience copies) to detect known vulnerabilities, and fix exploitable vulnerabilities or verify them as unexploitable. [dependency_monitoring]
    This can be done using an origin analyzer / dependency checking tool / software composition analysis tool such as OWASP's Dependency-Check, Sonatype's Nexus Auditor, Synopsys' Black Duck Software Composition Analysis, and Bundler-audit (for Ruby). Some package managers include mechanisms to do this. It is acceptable if the components' vulnerability cannot be exploited, but this analysis is difficult and it is sometimes easier to simply update or fix the part.

    Dependencies are monitored continuously and from several directions: Dependabot opens weekly grouped update pull requests, the dependency-review workflow blocks any pull request that introduces a dependency with a known advisory, the Socket.dev GitHub App reviews every dependency change for malware and install scripts, pnpm audit runs at high severity, and a 3-day minimumReleaseAge cooldown keeps just-published releases out. The only two accepted advisory bypasses are transitive Docusaurus build-time packages with no patched version available - both verified as not reachable from published code, and both carrying a dated review marker that fails CI when it expires. See https://github.com/allxsmith/bestax/blob/main/SECURITY.md


    Enough for a badge!

    The project MUST either:
    1. make it easy to identify and update reused externally-maintained components; or
    2. use the standard components provided by the system or programming language.
    Then, if a vulnerability is found in a reused component, it will be easy to update that component. [updateable_reused_components]
    A typical way to meet this criterion is to use system and programming language package management systems. Many FLOSS programs are distributed with "convenience libraries" that are local copies of standard libraries (possibly forked). By itself, that's fine. However, if the program *must* use these local (forked) copies, then updating the "standard" libraries as a security update will leave these additional copies still vulnerable. This is especially an issue for cloud-based systems; if the cloud provider updates their "standard" libraries but the program won't use them, then the updates don't actually help. See, e.g., "Chromium: Why it isn't in Fedora yet as a proper package" by Tom Callaway.

    All reused components are ordinary npm dependencies declared in package.json and pinned by the lockfile - there are no vendored or convenience copies anywhere in the tree - so updating one is a version bump plus pnpm install, which is what Dependabot automates weekly. The published library reuses exactly one runtime component, Bulma v1, on a caret range so consumers pick up its patches.


    Enough for a badge!

    The project SHOULD avoid using deprecated or obsolete functions and APIs where FLOSS alternatives are available in the set of technology it uses (its "technology stack") and to a supermajority of the users the project supports (so that users have ready access to the alternative). [interfaces_current]

    The stack is current and free of deprecated APIs: React function components with hooks only (no legacy class lifecycle, no legacy context, no findDOMNode), React 19 with a CI matrix that also proves React 18 compatibility, ESLint flat config, ES modules throughout, Bulma v1, and TypeScript 6. eslint-react and react-hooks rules flag deprecated React usage, and the typecheck catches removed APIs on every dependency upgrade.


  • Automated test suite


    Enough for a badge!

    An automated test suite MUST be applied on each check-in to a shared repository for at least one branch. This test suite MUST produce a report on test success or failure. [automated_integration_testing]
    This requirement can be viewed as a subset of test_continuous_integration, but focused on just testing, without requiring continuous integration.

    The full automated suite runs on every push and pull request to main and reports pass or fail as a required GitHub status check: build, typecheck, unit tests, coverage, bundle stats, lint, format check and conformance checks, plus a React 18/19 compatibility matrix and Playwright end-to-end scaffolding runs. See https://github.com/allxsmith/bestax/blob/main/.github/workflows/ci.yml and the checks on any pull request at https://github.com/allxsmith/bestax/pulls


    Enough for a badge!

    The project MUST add regression tests to an automated test suite for at least 50% of the bugs fixed within the last six months. [regression_tests_added50]

    Well over half of the bugs fixed in the last six months came with a regression test in the same pull request; the 99% coverage gate on bulma-ui makes it very difficult to merge a fix without one, and CONTRIBUTING.md requires unit tests for bug fixes as well as features. See merged fix commits at https://github.com/allxsmith/bestax/pulls?q=is%3Apr+is%3Amerged+fix


    Enough for a badge!

    The project MUST have FLOSS automated test suite(s) that provide at least 80% statement coverage if there is at least one FLOSS tool that can measure this criterion in the selected language. [test_statement_coverage80]
    Many FLOSS tools are available to measure test coverage, including gcov/lcov, Blanket.js, Istanbul, JCov, and covr (R). Note that meeting this criterion is not a guarantee that the test suite is thorough, instead, failing to meet this criterion is a strong indicator of a poor test suite.

    Statement coverage is enforced above 80% by jest, a FLOSS tool, and the build fails below it: 99% statements (and branches, functions, lines) for bulma-ui per https://github.com/allxsmith/bestax/blob/main/bulma-ui/jest.config.js, and 95% for every other jest package. pnpm test:coverage runs on every push and pull request in CI.


  • New functionality testing


    Enough for a badge!

    The project MUST have a formal written policy that as major new functionality is added, tests for the new functionality MUST be added to an automated test suite. [test_policy_mandated]

    The written policy is in the contribution requirements: all tests must pass and per-package coverage thresholds must be met for a pull request to be accepted, and unit tests are required for all new features and bug fixes - https://github.com/allxsmith/bestax/blob/main/CONTRIBUTING.md#code-quality-standards. Because coverage is a hard gate in CI rather than a request, adding functionality without tests fails the build.


    Enough for a badge!

    The project MUST include, in its documented instructions for change proposals, the policy that tests are to be added for major new functionality. [tests_documented_added]
    However, even an informal rule is acceptable as long as the tests are being added in practice.

    The policy is documented in the contribution instructions - https://github.com/allxsmith/bestax/blob/main/CONTRIBUTING.md#development-workflow step 5 (update/add unit tests, coverage must stay above the threshold) - and repeated as a checklist item in the pull request template: https://github.com/allxsmith/bestax/blob/main/.github/pull_request_template.md


  • Warning flags


    Enough for a badge!

    Projects MUST be maximally strict with warnings in the software produced by the project, where practical. [warnings_strict]
    Some warnings cannot be effectively enabled on some projects. What is needed is evidence that the project is striving to enable warning flags where it can, so that errors are detected early.

    TypeScript strict mode is on repository-wide with noUnusedLocals, ESLint runs recommended plus React, react-hooks, Storybook and Prettier rule sets, and additional house rules are enforced by pnpm check:conformance (documentation and story coverage, SCSS patterns, an inline-style ratchet, and expiry dates on every supply-chain bypass).


 Security 12/13 ●

  • Secure development knowledge


    Enough for a badge!

    The project MUST implement secure design principles (from "know_secure_design"), where applicable. If the project is not producing software, select "not applicable" (N/A). [implement_secure_design]
    For example, the project results should have fail-safe defaults (access decisions should deny by default, and projects' installation should be secure by default). They should also have complete mediation (every access that might be limited must be checked for authority and be non-bypassable). Note that in some cases principles will conflict, in which case a choice must be made (e.g., many mechanisms can make things more complex, contravening "economy of mechanism" / keep it simple).

    The secure design principles named in know_secure_design are implemented where they apply. Least privilege: every workflow defaults to contents: read, the release job re-declares only the scopes it needs, and the release App token is scoped to three permissions on one repository and expires within the hour. No long-lived secrets: npm publishing uses OIDC trusted publishing, so there is no NPM_TOKEN to steal. Fail closed: the inbound security triage flags rather than passes when it errors, and it holds no write-capable credentials so an injected scan cannot write to the repository. Limited attack surface in the produced software: the library performs no network access, no persistence and no dynamic code evaluation, renders through React's escaping rather than raw HTML, and ships a single runtime dependency. Defence in depth around changes: protected main, required human review, layered automated review, dependency review, Socket.dev, and CodeQL. See https://github.com/allxsmith/bestax/blob/main/SECURITY.md


  • Use basic good cryptographic practices

    Note that some software does not need to use cryptographic mechanisms. If your project produces software that (1) includes, activates, or enables encryption functionality, and (2) might be released from the United States (US) to outside the US or to a non-US-citizen, you may be legally required to take a few extra steps. Typically this just involves sending an email. For more information, see the encryption section of Understanding Open Source Technology & US Export Controls.

    Enough for a badge!

    The default security mechanisms within the software produced by the project MUST NOT depend on cryptographic algorithms or modes with known serious weaknesses (e.g., the SHA-1 cryptographic hash algorithm or the CBC mode in SSH). [crypto_weaknesses]
    Concerns about CBC mode in SSH are discussed in CERT: SSH CBC vulnerability.

    This project produces a React UI component library, a project scaffolder, a codemod and an MCP server. None of them include, activate, enable or call cryptographic functionality, and none store passwords or generate keys or nonces, so this criterion is not applicable. Transport security for distribution and the docs site is provided by HTTPS, which is covered under delivery_mitm and sites_https. This project produces a React UI component library, a project scaffolder, a codemod and an MCP server. None of them implement, call, configure or process cryptography, credentials, private keys or network connections of their own, so this criterion is not applicable. Transport security for distribution and the documentation site is provided by HTTPS and is covered under delivery_mitm and sites_https.


    Enough for a badge!

    The project SHOULD support multiple cryptographic algorithms, so users can quickly switch if one is broken. Common symmetric key algorithms include AES, Twofish, and Serpent. Common cryptographic hash algorithm alternatives include SHA-2 (including SHA-224, SHA-256, SHA-384 AND SHA-512) and SHA-3. [crypto_algorithm_agility]

    This project produces a React UI component library, a project scaffolder, a codemod and an MCP server. None of them implement, call, configure or process cryptography, credentials, private keys or network connections of their own, so this criterion is not applicable. Transport security for distribution and the documentation site is provided by HTTPS and is covered under delivery_mitm and sites_https.


    Enough for a badge!

    The project MUST support storing authentication credentials (such as passwords and dynamic tokens) and private cryptographic keys in files that are separate from other information (such as configuration files, databases, and logs), and permit users to update and replace them without code recompilation. If the project never processes authentication credentials and private cryptographic keys, select "not applicable" (N/A). [crypto_credential_agility]

    This project produces a React UI component library, a project scaffolder, a codemod and an MCP server. None of them implement, call, configure or process cryptography, credentials, private keys or network connections of their own, so this criterion is not applicable. Transport security for distribution and the documentation site is provided by HTTPS and is covered under delivery_mitm and sites_https.


    Enough for a badge!

    The software produced by the project SHOULD support secure protocols for all of its network communications, such as SSHv2 or later, TLS1.2 or later (HTTPS), IPsec, SFTP, and SNMPv3. Insecure protocols such as FTP, HTTP, telnet, SSLv3 or earlier, and SSHv1 SHOULD be disabled by default, and only enabled if the user specifically configures it. If the software produced by the project does not support network communications, select "not applicable" (N/A). [crypto_used_network]

    This project produces a React UI component library, a project scaffolder, a codemod and an MCP server. None of them implement, call, configure or process cryptography, credentials, private keys or network connections of their own, so this criterion is not applicable. Transport security for distribution and the documentation site is provided by HTTPS and is covered under delivery_mitm and sites_https.


    Enough for a badge!

    The software produced by the project SHOULD, if it supports or uses TLS, support at least TLS version 1.2. Note that the predecessor of TLS was called SSL. If the software does not use TLS, select "not applicable" (N/A). [crypto_tls12]

    This project produces a React UI component library, a project scaffolder, a codemod and an MCP server. None of them implement, call, configure or process cryptography, credentials, private keys or network connections of their own, so this criterion is not applicable. Transport security for distribution and the documentation site is provided by HTTPS and is covered under delivery_mitm and sites_https.


    Enough for a badge!

    The software produced by the project MUST, if it supports TLS, perform TLS certificate verification by default when using TLS, including on subresources. If the software does not use TLS, select "not applicable" (N/A). [crypto_certificate_verification]
    Note that incorrect TLS certificate verification is a common mistake. For more information, see "The Most Dangerous Code in the World: Validating SSL Certificates in Non-Browser Software" by Martin Georgiev et al. and "Do you trust this application?" by Michael Catanzaro.

    This project produces a React UI component library, a project scaffolder, a codemod and an MCP server. None of them implement, call, configure or process cryptography, credentials, private keys or network connections of their own, so this criterion is not applicable. Transport security for distribution and the documentation site is provided by HTTPS and is covered under delivery_mitm and sites_https.


    Enough for a badge!

    The software produced by the project MUST, if it supports TLS, perform certificate verification before sending HTTP headers with private information (such as secure cookies). If the software does not use TLS, select "not applicable" (N/A). [crypto_verification_private]

    This project produces a React UI component library, a project scaffolder, a codemod and an MCP server. None of them implement, call, configure or process cryptography, credentials, private keys or network connections of their own, so this criterion is not applicable. Transport security for distribution and the documentation site is provided by HTTPS and is covered under delivery_mitm and sites_https.


  • Secure release


    Enough for a badge!

    The project MUST cryptographically sign releases of the project results intended for widespread use, and there MUST be a documented process explaining to users how they can obtain the public signing keys and verify the signature(s). The private key for these signature(s) MUST NOT be on site(s) used to directly distribute the software to the public. If releases are not intended for widespread use, select "not applicable" (N/A). [signed_releases]
    The project results include both source code and any generated deliverables where applicable (e.g., executables, packages, and containers). Generated deliverables MAY be signed separately from source code. These MAY be implemented as signed git tags (using cryptographic digital signatures). Projects MAY provide generated results separately from tools like git, but in those cases, the separate results MUST be separately signed.

    Every release is cryptographically signed. Each published tarball carries a signed npm provenance attestation (Sigstore) binding it to the exact source commit and CI run that produced it, minted by the release workflow with OIDC trusted publishing rather than a long-lived token; consumers verify with npm audit signatures, and the attestation is shown in the Provenance section of each npm package page. The corresponding git release tag and chore(release) commit are signed as well, and main rejects unsigned commits. See https://github.com/allxsmith/bestax/blob/main/SECURITY.md


    Enough for a badge!

    It is SUGGESTED that in the version control system, each important version tag (a tag that is part of a major release, minor release, or fixes publicly noted vulnerabilities) be cryptographically signed and verifiable as described in signed_releases. [version_tags_signed]

    Release tags are cryptographically signed. main rejects unsigned commits, and semantic-release pushes its chore(release) commit and the accompanying per-package tag through a GitHub App whose writes are signed, so every release tag in https://github.com/allxsmith/bestax/tags carries a verified signature. See the Protected main and npm provenance sections of https://github.com/allxsmith/bestax/blob/main/SECURITY.md


  • Other security issues


    Enough for a badge!

    The project results MUST check all inputs from potentially untrusted sources to ensure they are valid (an *allowlist*), and reject invalid inputs, if there are any restrictions on the data at all. [input_validation]
    Note that comparing input against a list of "bad formats" (aka a *denylist*) is normally not enough, because attackers can often work around a denylist. In particular, numbers are converted into internal formats and then checked if they are between their minimum and maximum (inclusive), and text strings are checked to ensure that they are valid text patterns (e.g., valid UTF-8, length, syntax, etc.). Some data may need to be "anything at all" (e.g., a file uploader), but these would typically be rare.

    Untrusted input is identified and restricted to what is expected at each entry point. The library's inputs are component props, which are constrained by exported TypeScript types checked at consumer build time, narrowed to enumerated unions wherever Bulma allows only a fixed set of values, and rendered as text through React's escaping - the components never evaluate code and never inject raw HTML on the caller's behalf. bestax-mcp validates every tool call against a declared zod schema before acting on it. create-bestax validates project names and its flag values (template, CSS flavor, icon set) against known-good sets before touching the filesystem. bestax-migrate operates on a parsed AST rather than on text substitution. The prop contracts are documented per component at https://bestax.io/docs/api


    Enough for a badge!

    Hardening mechanisms SHOULD be used in the software produced by the project so that software defects are less likely to result in security vulnerabilities. [hardening]
    Hardening mechanisms may include HTTP headers like Content Security Policy (CSP), compiler flags to mitigate attacks (such as -fstack-protector), or compiler flags to eliminate undefined behavior. For our purposes least privilege is not considered a hardening mechanism (least privilege is important, but separate).

    Hardening is applied where it can be: the produced software is written entirely in memory-safe TypeScript/JavaScript, uses no eval or dynamic code construction, injects no raw HTML, requests no network or storage access, and is therefore compatible with a strict Content-Security-Policy in the consuming application. Build and release are hardened as well - read-only default tokens, SHA-pinned actions, blocked dependency install scripts, isolated node_modules, a frozen lockfile, and short-lived OIDC credentials. The documentation site and repository are served over HTTPS by Cloudflare and GitHub. See https://github.com/allxsmith/bestax/blob/main/SECURITY.md


    Not enough for a badge.

    The project MUST provide an assurance case that justifies why its security requirements are met. The assurance case MUST include: a description of the threat model, clear identification of trust boundaries, an argument that secure design principles have been applied, and an argument that common implementation security weaknesses have been countered. (URL required) [assurance_case]
    An assurance case is "a documented body of evidence that provides a convincing and valid argument that a specified set of critical claims regarding a system’s properties are adequately justified for a given application in a given environment" ("Software Assurance Using Structured Assurance Case Models", Thomas Rhodes et al, NIST Interagency Report 7608). Trust boundaries are boundaries where data or execution changes its level of trust, e.g., a server's boundaries in a typical web application. It's common to list secure design principles (such as Saltzer and Schroeer) and common implementation security weaknesses (such as the OWASP top 10 or CWE/SANS top 25), and show how each are countered. The BadgeApp assurance case may be a useful example. This is related to documentation_security, documentation_architecture, and implement_secure_design.

    The project has no written assurance case. The individual ingredients exist and are documented - the threat model for the release pipeline, the secure design principles applied, the mitigations and why they are believed sufficient, all in https://github.com/allxsmith/bestax/blob/main/SECURITY.md - but they have not been assembled into a document that states the security requirements, argues how the design and controls satisfy them, and justifies why the remaining risk is acceptable. Closing this means writing that argument down as its own document.


 Analysis 2/2 ●

  • Static code analysis


    Enough for a badge!

    The project MUST use at least one static analysis tool with rules or approaches to look for common vulnerabilities in the analyzed language or environment, if there is at least one FLOSS tool that can implement this criterion in the selected language. [static_analysis_common_vulnerabilities]
    Static analysis tools that are specifically designed to look for common vulnerabilities are more likely to find them. That said, using any static tools will typically help find some problems, so we are suggesting but not requiring this for the 'passing' level badge.

    CodeQL is exactly such a tool: its JavaScript/TypeScript security query suites look for common vulnerability classes in this language and environment (injection, XSS, unsafe deserialization, path traversal, and more), and it also scans the GitHub Actions workflows for common CI/CD weaknesses.


  • Dynamic code analysis


    Enough for a badge!

    If the software produced by the project includes software written using a memory-unsafe language (e.g., C or C++), then at least one dynamic tool (e.g., a fuzzer or web application scanner) MUST be routinely used in combination with a mechanism to detect memory safety problems such as buffer overwrites. If the project does not produce software written in a memory-unsafe language, choose "not applicable" (N/A). [dynamic_analysis_unsafe]
    Examples of mechanisms to detect memory safety problems include Address Sanitizer (ASAN) (available in GCC and LLVM), Memory Sanitizer, and valgrind. Other potentially-used tools include thread sanitizer and undefined behavior sanitizer. Widespread assertions would also work.

    The project produces no software written in a memory-unsafe language. All source is TypeScript, JavaScript and SCSS, running on the JavaScript engine of a browser or Node.js.



This data is available under the Community Data License Agreement – Permissive, Version 2.0 (CDLA-Permissive-2.0). This means that a Data Recipient may share the Data, with or without modifications, so long as the Data Recipient makes available the text of this agreement with the shared Data. Please credit Alex Smith and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Alex Smith.
Entry created on 2026-08-29 22:01:18 UTC, last updated on 2026-08-29 22:23:38 UTC. Last achieved passing badge on 2026-08-29 22:13:27 UTC.