commitment-issues

Проекты, которые следуют приведенным ниже лучшим практикам, могут добровольно и самостоятельно оценить себя и продемонстрировать, что они получили значок Open Source Security Foundation (OpenSSF).

Не существует набора практик, гарантирующего, что у программного обеспечения никогда не будет недостатков или уязвимостей; даже формальные методы могут не помочь, если спецификации или допущения ошибочны. Также не существует какой-либо практики, которая могла бы гарантировать, что проект будет поддерживать здоровое и хорошо функционирующее сообщество разработчиков. Однако следующие хорошие правила могут помочь улучшить результаты проектов. Например, некоторые правила описывают ревью несколькими участниками перед выпуском, что может помочь найти технические уязвимости, которые было бы сложно найти другим способом, и помочь построить доверие и желание дальнейшего взаимодействия между разработчиками из разных компаний. Чтобы получить значок, нужно выполнить все критерии с ключевыми словами "НЕОБХОДИМО"/"ОБЯЗАН"/"НЕДОПУСТИМО", все критерии со словом "СЛЕДУЕТ" либо должны удовлетворяться, либо должно быть приведено обоснование их невыполнения, и все критерии со словом "ЖЕЛАТЕЛЬНО" могут быть удовлетворены ИЛИ неудовлетворены (желательно, чтобы они были хотя бы рассмотрены). Если вы хотите ввести общий комментарий вместо объяснения, почему текущая ситуация приемлема, начните текст с '//' и пробела. Приветствуется обратная связь через сайт на GitHub в виде issues или pull requests. Существует также список рассылки для общих вопросов.

Мы с удовольствием предоставляем информацию на нескольких языках, однако, если есть какой-либо конфликт или несоответствие между переводами, английская версия является авторитетной.
Если это ваш проект, пожалуйста, отобразите статус вашего базового значка на странице проекта! Статус базового значка выглядит так: Базовый уровень значка для проекта 13528 - baseline-1 Вот как встроить базовый значок:
Вы можете показать статус базового значка, вставив это в ваш файл markdown:
[![OpenSSF Baseline](https://www.bestpractices.dev/projects/13528/baseline)](https://www.bestpractices.dev/projects/13528)
или вставив это в ваш HTML:
<a href="https://www.bestpractices.dev/projects/13528"><img src="https://www.bestpractices.dev/projects/13528/baseline"></a>


Это критерии Базового Уровня 2. Это критерии версии v2026.02.19.

Baseline Series: Базовый уровень 1 Базовый Уровень 2 Базовый Уровень 3

        

 Основы

  • Общая

    Обратите внимание, что другие проекты могут использовать то же имя.

    For developers who overthink every commit. Advisory-first pre-commit and pre-push checks for JavaScript and TypeScript projects using Husky, lint-staged, ESLint, and Prettier. Advisory by default: commitment-issues reports issues without discarding unstaged work, rewriting already-pushed history, or blocking pushes.

    Используйте формат выражения лицензии SPDX; примеры включают «Apache-2.0», «BSD-2-Clause», «BSD-3-Clause», «GPL-2.0+», «LGPL-3.0+», «MIT» и «(BSD-2-Clause OR Ruby)».
    Если используется более одного языка, перечислите их через запятую (пробелы необязательны), и отсортируйте их от наиболее до наименее используемого. Если список длинный, пожалуйста, перечислите по крайней мере три наиболее распространенных. Если языка нет (например, это проект только для документации или только для тестирования), используйте один символ «-» (минус). Для каждого языка используйте общепринятую капитализацию названия, например «JavaScript».
    Common Platform Enumeration (CPE) - это структурированная схема именования для информационных систем, программного обеспечения и пакетов. Она используется в ряде систем и баз данных для отчетов об уязвимостях.

 Элементы управления 16/19

  • Элементы управления


    Когда задача CI/CD выполняется без указания прав доступа, система CI/CD ОБЯЗАНА по умолчанию назначать задаче минимальные права, предоставленные в конвейере. [OSPS-AC-04.01]
    Настройте параметры проекта для назначения минимальных доступных прав новым конвейерам по умолчанию, предоставляя дополнительные права только при необходимости для конкретных задач.


    Когда создается официальный выпуск, этому выпуску ОБЯЗАН быть назначен уникальный идентификатор версии. [OSPS-BR-02.01]
    Присваивайте уникальный идентификатор версии каждому выпуску, создаваемому проектом, следуя согласованному соглашению о наименовании или схеме нумерации. Примеры включают SemVer, CalVer или идентификатор коммита git.

    Each release intended for users has a unique semantic version identifier in package.json, such as 3.0.1. The release workflow is triggered by version tags matching v* and verifies that the Git tag matches the package.json version before publishing. This ensures user-facing releases are uniquely identified.

    https://github.com/RoryGlenn/commitment-issues/blob/main/package.json [version_unique]



    Когда создается официальный выпуск, этот выпуск ОБЯЗАН содержать описательный журнал функциональных изменений и изменений безопасности. [OSPS-BR-04.01]
    Убедитесь, что все выпуски содержат описательный журнал изменений. Рекомендуется обеспечить, чтобы журнал изменений был читаемым человеком и содержал более подробные сведения, чем сообщения коммитов, такие как описания влияния на безопасность или релевантность для различных сценариев использования. Для обеспечения машиночитаемости размещайте содержимое под заголовком markdown, таким как "## Changelog".

    Non-trivial release notes file in repository: https://github.com/RoryGlenn/commitment-issues/blob/main/CHANGELOG.md. [release_notes]



    Когда конвейер сборки и выпуска загружает зависимости, он ОБЯЗАН использовать стандартизированные инструменты, где они доступны. [OSPS-BR-05.01]
    Используйте общие инструменты для вашей экосистемы, такие как менеджеры пакетов или инструменты управления зависимостями для загрузки зависимостей во время сборки. Это может включать использование файла зависимостей, lock-файла или манифеста для указания требуемых зависимостей, которые затем подключаются системой сборки.

    The project lists external dependencies in computer-processable npm metadata. package.json declares runtime dependencies, development dependencies, peer dependencies, and the supported Node engine, while package-lock.json records resolved dependency versions, integrity hashes, licenses, and transitive dependency metadata. Evidence is here: https://github.com/RoryGlenn/commitment-issues/blob/main/package.json and https://github.com/RoryGlenn/commitment-issues/blob/main/package-lock.json. [external_dependencies]



    Когда создается официальный выпуск, этот выпуск ОБЯЗАН быть подписан или учтен в подписанном манифесте, включающем криптографические хеши каждого актива. [OSPS-BR-06.01]
    Подписывайте все выпущенные программные активы во время сборки с использованием криптографической подписи или аттестаций, таких как подпись GPG или PGP, подписи Sigstore, происхождение SLSA или SLSA VSA. Включите криптографические хеши каждого актива в подписанный манифест или файл метаданных.

    Already publishing with npm publish --provenance, npm generates a Sigstore attestation for the published package. If GitHub Release assets are also published, they should either be signed or accompanied by a signed manifest containing their hashes.



    Когда проект создал выпуск, документация проекта ОБЯЗАНА включать описание того, как проект выбирает, получает и отслеживает свои зависимости. [OSPS-DO-06.01]
    Рекомендуется публиковать эту информацию вместе с технической документацией и документацией по дизайну проекта в общедоступном ресурсе, таком как репозиторий исходного кода, веб-сайт проекта или другой канал.

    No / In progress.

    The project uses the standard npm ecosystem for dependency management, including package.json, package-lock.json, and npm ci. However, the project documentation does not yet include a dedicated description of how dependencies are selected, obtained, and tracked.

    To satisfy this requirement, the project will add dependency-management documentation describing:

    • how dependencies are selected;
    • how dependencies are obtained;
    • how dependency versions are locked and tracked;
    • how dependency updates are reviewed;
    • how security advisories and vulnerability fixes are handled.


    Документация проекта ДОЛЖНА включать инструкции по сборке программного обеспечения, включая необходимые библиотеки, фреймворки, SDK и зависимости. [OSPS-DO-07.01]
    Рекомендуется публиковать эту информацию вместе с документацией для участников проекта, например в файле CONTRIBUTING.md или другой документации по задачам разработчика. Это также может быть задокументировано с помощью целей Makefile или других сценариев автоматизации.

    The project provides a quick, common development setup using git and npm. Potential developers can fork and clone the repository, run npm install, then verify the development/test environment with npm test, npm run lint, and npm run format:check. The contributing guide also documents how to run the full test suite and individual test files. Evidence is here: https://github.com/RoryGlenn/commitment-issues/blob/main/.github/CONTRIBUTING.md#getting-started. [installation_development_quick]



    Пока проект активен, документация проекта ОБЯЗАНА включать список членов проекта с доступом к критическим ресурсам. [OSPS-GV-01.01]
    Документируйте участников проекта и их роли с помощью таких артефактов, как members.md, governance.md, maintainers.md или аналогичного файла в репозитории исходного кода проекта. Это может быть просто включение имен или учетных записей в список сопровождающих или более сложное в зависимости от управления проектом.

    The project maintains documentation identifying the individuals with access to sensitive project resources, including repository administration, release publishing, package publishing, security settings, and signing credentials. This documentation is kept up to date while the project is active.



    Пока проект активен, документация проекта ОБЯЗАНА включать описания ролей и обязанностей для членов проекта. [OSPS-GV-01.02]
    Документируйте участников проекта и их роли с помощью таких артефактов, как members.md, governance.md, maintainers.md или аналогичного файла в репозитории исходного кода проекта.

    The project documentation defines the roles and responsibilities for each project member. This includes responsibilities for project governance, reviewing contributions, approving and publishing releases, responding to security reports, maintaining project documentation, managing CI/CD and repository settings, and maintaining dependencies. The documentation is kept current as project membership changes.



    Пока проект активен, документация проекта ОБЯЗАНА включать руководство для участников кода, которое включает требования к приемлемым вкладам. [OSPS-GV-03.02]
    Расширьте содержимое CONTRIBUTING.md или CONTRIBUTING/ в документации проекта, чтобы изложить требования к приемлемым вкладам, включая стандарты кодирования, требования к тестированию и руководства по отправке для участников кода. Рекомендуется, чтобы это руководство было источником истины как для участников, так и для утверждающих.

    The contributing guide documents requirements for acceptable contributions. Pull requests should include tests for behavior changes and regression tests for bug fixes, stay focused to one logical change, pass npm test, npm run lint, and npm run format:check, update the changelog and documentation for user-visible changes, and follow the project's advisory-first design philosophy. The guide also documents the coding style: Prettier for formatting, ESLint flat config for linting, small composable functions, clear names, and comments only where intent is non-obvious.

    https://github.com/RoryGlenn/commitment-issues/blob/main/.github/CONTRIBUTING.md#contribution-requirements [contribution_requirements]



    Пока проект активен, система контроля версий ОБЯЗАНА требовать от всех участников кода утверждать, что они имеют законное право вносить соответствующий вклад в каждом коммите. [OSPS-LE-01.01]
    Включите DCO в репозиторий проекта, требуя от участников кода утверждать, что они имеют законное право вносить соответствующий вклад в каждом коммите. Используйте проверку статуса, чтобы убедиться, что утверждение сделано. CLA также удовлетворяет этому требованию. Некоторые системы контроля версий, такие как GitHub, могут включать это в условия обслуживания платформы.

    The project currently states that contributions are licensed under the MIT License, but it does not yet document a DCO, CLA, Signed-off-by requirement, or equivalent contributor authorization mechanism. Current partial contribution/legal language is here: https://github.com/RoryGlenn/commitment-issues/blob/main/.github/CONTRIBUTING.md#opening-a-pull-request. [dco]



    При внесении коммита в основную ветку все автоматические проверки статуса для коммитов ДОЛЖНЫ пройти успешно или быть явно обойдены вручную. [OSPS-QA-03.01]
    Настройте систему контроля версий проекта таким образом, чтобы все автоматические проверки статуса должны были пройти успешно или требовать ручного подтверждения перед тем, как коммит может быть объединен с основной веткой. Рекомендуется НЕ настраивать необязательные проверки статуса как требование успешного прохождения или провала, которые утверждающие могут быть склонны обойти.

    The project applies an automated test suite on each check-in to the shared repository through GitHub Actions. The CI workflow runs on pushes to main and pull requests, and it reports success or failure for linting, formatting, automated tests, package lifecycle smoke tests, coverage, and package-manager smoke tests. Evidence is here: https://github.com/RoryGlenn/commitment-issues/blob/main/.github/workflows/ci.yml. [automated_integration_testing]



    Перед принятием коммита в проекте ДОЛЖЕН выполняться хотя бы один автоматизированный набор тестов в конвейере CI/CD для обеспечения соответствия изменений ожиданиям. [OSPS-QA-06.01]
    Автоматизированные тесты должны выполняться перед каждым объединением с основной веткой. Набор тестов должен выполняться в конвейере CI/CD, и результаты должны быть видны всем участникам. Набор тестов должен выполняться в согласованной среде и таким образом, чтобы участники могли выполнять тесты локально. Примеры наборов тестов включают модульные тесты, интеграционные тесты и сквозные тесты.

    The project applies an automated test suite on each check-in to the shared repository through GitHub Actions. The CI workflow runs on pushes to main and pull requests, and it reports success or failure for linting, formatting, automated tests, package lifecycle smoke tests, coverage, and package-manager smoke tests. Evidence is here: https://github.com/RoryGlenn/commitment-issues/blob/main/.github/workflows/ci.yml. [automated_integration_testing]



    Когда проект выпустил релиз, документация проекта ДОЛЖНА включать проектную документацию, демонстрирующую все действия и участников в системе. [OSPS-SA-01.01]
    Включите в документацию проекта проектные описания, объясняющие действия и участников. Участники включают любую подсистему или сущность, которая может повлиять на другой сегмент в системе. Убедитесь, что эта информация обновляется для новых функций или критических изменений.

    The project documents its high-level architecture and public interface through the contributing guide and external interface reference. The contributing guide describes the project layout, including entry-point scripts, shared helper modules, tests, docs, and CI workflows. The external interface reference documents CLI commands, init-added scripts, Git hook entrypoints, configuration keys/defaults, output behavior, and exit behavior. Evidence is here: https://github.com/RoryGlenn/commitment-issues/blob/main/.github/CONTRIBUTING.md#project-layout and https://github.com/RoryGlenn/commitment-issues/blob/main/docs/external-interface.md [documentation_architecture]



    Когда проект выпустил релиз, документация проекта ДОЛЖНА включать описания всех внешних программных интерфейсов выпущенных программных активов. [OSPS-SA-02.01]
    Документируйте все программные интерфейсы (API) выпущенных программных активов, объясняя, как пользователи могут взаимодействовать с программным обеспечением и какие данные ожидаются или производятся. Убедитесь, что эта информация обновляется для новых функций или критических изменений.

    [documentation_interface]



    Когда проект выпустил релиз, проект ДОЛЖЕН провести оценку безопасности для понимания наиболее вероятных и значимых потенциальных проблем безопасности, которые могут возникнуть в программном обеспечении. [OSPS-SA-03.01]
    Проведение оценки безопасности информирует как членов проекта, так и конечных потребителей о том, что проект понимает, какие проблемы могут возникнуть в программном обеспечении. Понимание того, какие угрозы могут быть реализованы, помогает проекту управлять рисками и справляться с ними. Эта информация полезна для конечных потребителей для демонстрации компетентности в области безопасности и практик проекта. Убедитесь, что эта информация обновляется для новых функций или критических изменений.

    The project performed a documented security review on 2026-07-08. The review considered the security boundary: commitment-issues runs locally in user repositories, shells out to local tools such as ESLint, Prettier, and the configured test runner, reads local Git state/files, does not expose a network service, and does not transmit repository content. The review covered CLI entrypoints, shared helpers, Git hook wiring, pre-commit/pre-push execution paths, and release/CI workflows. [security_review]



    Пока проект активен, документация проекта ДОЛЖНА включать политику координированного раскрытия уязвимостей (CVD) с четко определенными сроками ответа. [OSPS-VM-01.01]
    Создайте файл SECURITY.md в корневом каталоге, описывающий политику проекта для координированного раскрытия уязвимостей. Включите метод сообщения об уязвимостях. Установите ожидания относительно того, как проект будет реагировать и решать сообщенные проблемы.

    The project publishes its vulnerability reporting process in SECURITY.md: https://github.com/RoryGlenn/commitment-issues/blob/main/.github/SECURITY.md. The policy tells users how to report vulnerabilities privately through GitHub Security Advisories, asks reporters not to open public issues for suspected vulnerabilities, and explains what details to include in a report. [vulnerability_report_process]



    Пока проект активен, документация проекта ДОЛЖНА предоставлять средства для приватного сообщения об уязвимостях непосредственно контактам по безопасности в проекте. [OSPS-VM-03.01]
    Предоставьте средства для того, чтобы исследователи безопасности могли приватно сообщать об уязвимостях в проект. Это может быть специальный адрес электронной почты, веб-форма, специализированные инструменты системы контроля версий, адреса электронной почты контактов по безопасности или другие методы.

    The project supports private vulnerability reports and documents how to send them privately in SECURITY.md: https://github.com/RoryGlenn/commitment-issues/blob/main/.github/SECURITY.md. The policy instructs reporters to use GitHub's private vulnerability reporting / Security Advisories flow and explicitly says not to open a public issue for suspected vulnerabilities. [vulnerability_report_private]



    Пока проект активен, документация проекта ДОЛЖНА публично публиковать данные об обнаруженных уязвимостях. [OSPS-VM-04.01]
    Предоставляйте информацию об известных уязвимостях в предсказуемом публичном канале, таком как запись CVE, запись в блоге или другом носителе. По мере возможности эта информация должна включать затронутые версии, как потребитель может определить, уязвим ли он, и инструкции по смягчению последствий или исправлению.

    To satisfy this requirement, the project will maintain a public vulnerability history (for example, docs/vulnerability-history.md or GitHub Security Advisories) documenting all disclosed vulnerabilities. If no vulnerabilities have been discovered, the documentation will explicitly state that no publicly disclosed vulnerabilities have been reported to date and will be updated as future disclosures occur.



Эти данные доступны по лицензии Community Data License Agreement – Permissive, Version 2.0 (CDLA-Permissive-2.0). Это означает, что получатель данных может распространять данные с изменениями или без них, при условии, что получатель данных предоставляет текст данного соглашения вместе с распространяемыми данными. Пожалуйста, укажите в качестве источника RoryGlenn и участников OpenSSF Best Practices badge.

Владелец анкеты на значок проекта: RoryGlenn.
2026-07-08 02:38:47 UTC, последнее изменение сделано 2026-07-09 21:04:40 UTC. Последний раз условия для получения значка были выполнены 2026-07-09 17:43:22 UTC.