m3l-groundwork

Miradi inayofuata mazoea bora hapa chini inaweza kujihakikisha kwa hiari na kuonyesha kuwa wamepata nishani ya mazoea bora ya Open Source Security Foundation (OpenSSF).

Hakuna seti ya mazoea yawezayo kuhakikisha kuwa programu haitakuwa na kasoro au udhaifu; hata mbinu rasmi zinaweza kushindwa ikiwa vipimo au dhana ni sahihi. Wala hakuna seti ya mazoea yawezayo kuhakikisha kuwa mradi utaendelea kuwa na jamii ya maendeleo yenye afya na inayofanya kazi vizuri. Hata hivyo, kufuata mazoea bora kunaweza kusaidia kuboresha matokeo ya miradi. Kwa mfano, baadhi ya mazoea huwezesha ukaguzi wa watu wengi kabla ya kutolewa, ambayo inaweza kusaidia kupata udhaifu wa kiufundi ambao vinginevyo ni vigumu kupata na kusaidia kujenga uaminifu na hamu ya mwingiliano wa kurudia kati ya wasanidi programu kutoka makampuni tofauti. Ili kupata nishani, vigezo vyote vya LAZIMA na LAZIMA WALA USIWAHI lazima vifuatwe, vigezo vyote vya INAPASWA lazima vifuatwe AU visivyo fufufutiliana na thibitisho, na vigezo vyote vya PENDEKEZA lazima vifuatwe AU visivyo fufufutiliana (tunataka vifikiwe angalau). Ikiwa unataka kuingiza maandishi ya thibitisho kama maoni ya jumla, badala ya kuwa maelezo ya busara kwamba hali ni inakubaliwa, anza kifungu cha maandishi na '//' ikifuatiwa na nafasi. Maoni ni karibu kupitia tovuti ya GitHub kama masuala au maombi ya kuvuta Kuna pia orodha ya barua pepe kwa majadiliano ya jumla.

Tunafuraha kutoa habari katika lugha nyingi, hata hivyo, ikiwa kuna mgongano au kutokuwa na usawa kati ya tafsiri, toleo la Kiingereza ni toleo lenye mamlaka.
Ikiwa huu ni mradi wako, tafadhali onyesha hali ya nishani yako ya msingi kwenye ukurasa wa mradi wako! Hali ya nishani ya msingi inaonekana kama hii: Kiwango cha nishani ya msingi kwa mradi 14937 ni baseline-3 Huu ndiyo jinsi ya kuweka nishani ya msingi:
Unaweza kuonyesha hali ya nishani yako ya msingi kwa kuweka hii katika faili yako ya markdown:
[![OpenSSF Baseline](https://www.bestpractices.dev/projects/14937/baseline)](https://www.bestpractices.dev/projects/14937)
au kwa kuweka hii katika HTML yako:
<a href="https://www.bestpractices.dev/projects/14937"><img src="https://www.bestpractices.dev/projects/14937/baseline"></a>


Hizi ni vigezo vya Kiwango cha Msingi 3. Hizi ni vigezo vya toleo v2026.08.28.

Baseline Series: Kiwango cha Msingi 1 Kiwango cha Msingi 2 Kiwango cha Msingi 3

        

 Misingi

  • Jumla

    Kumbuka kwamba miradi mingine inaweza kutumia jina sawa.

    Deterministic TypeScript + Claude Code project bootstrapper, with an adaptive /customize pass over live TypeScript and Anthropic guidance.

    Tafadhali tumia muundo wa maneno ya leseni ya SPDX; mifano ni pamoja na "Apache-2.0", "BSD-2-Clause", "BSD-3-Clause", "GPL-2.0+", "LGPL-3.0+", "MIT", na "(BSD-2-Clause OR Ruby)". Usitumie alama za nukuu za moja au mbili.
    Ikiwa kuna lugha zaidi ya moja, ziorodhe kama thamani zilizotengwa kwa koma (nafasi ni za hiari) na ziorodhe kuanzia iliyotumiwa zaidi hadi iliyotumiwa kidogo. Ikiwa kuna orodha ndefu, tafadhali orodhesha angalau tatu za kawaida zaidi. Ikiwa hakuna lugha (k.m., huu ni mradi wa nyaraka tu au wa majaribio tu), tumia herufi moja "-". Tafadhali tumia herufi kubwa za kawaida kwa kila lugha, k.m., "JavaScript".
    Common Platform Enumeration (CPE) ni mpango wa kuweka majina yenye muundo kwa mifumo ya teknolojia ya habari, programu, na vifurushi. Inatumika katika mifumo na hifadhidata nyingi wakati wa kuripoti udhaifu.

 Udhibiti 21/21 ●

  • Udhibiti


    Ya kutosha kwa nishani!

    Ruhusa zinapopeana kwa kazi katika mfumo wa CI/CD, msimbo wa chanzo au usanidi LAZIMA upee tu ruhusa za chini zaidi zinazohitajika kwa shughuli zinazohusiana. [OSPS-AC-04.02]
    Sanidi mifumo ya CI/CD ya mradi ili kupea ruhusa za chini zinazopatikana kwa watumiaji na huduma kwa chaguomsingi, ukipandisha ruhusa tu inapohitajika kwa kazi maalum. Katika baadhi ya mifumo ya udhibiti wa toleo, hii inaweza kufanyika katika kiwango cha shirika au hifadhi. Ikiwa sivyo, weka ruhusa katika kiwango cha juu cha mfumo.

    Permissions are set per job, never inherited from a broad default (default workflow permissions are read; top-level permissions are read or empty). Each write scope sits in the job that needs it, with the reason in the file: publish in release.yml, scorecard.yml, security-audit.yml and labeler.yml.


    Ya kutosha kwa nishani!

    Mifuko ya CI/CD inayokubali pembejeo za mshirika anayeaminika LAZIMA isafishe na kuthibitisha pembejeo hiyo kabla ya kutumia katika mfuko. [OSPS-BR-01.04]
    Mifuko ya CI/CD inapaswa kusafisha (kunukuu, kutoroka au kutoka kwa maadili yanayotarajiwa) pembejeo zote za mshirika kwenye utekelezaji wa mtiririko wa kazi wa wazi. Ingawa washirika kwa ujumla wanaaminika, pembejeo za mwongozo kwa mtiririko wa kazi haiwezi kukaguliwa na inaweza kutumiwa vibaya na utekaji wa akaunti au tishio la ndani.

    Collaborator input reaches a shell only through env vars: soak.yml passes inputs.version as SOAK_VERSION, which bin/soak.sh rejects unless it matches [0-9A-Za-z.+-]; environments.yml passes a boolean dry_run through env. No workflow takes a comment or other free text into a shell.


    Ya kutosha kwa nishani!

    Toleo rasmi linapobuniwa, mali zote ndani ya toleo hilo LAZIMA zihusianishwe wazi na kitambulisho cha toleo au kitambulisho kingine cha kipekee kwa mali hiyo. [OSPS-BR-02.02]
    Panga kitambulisho cha kipekee cha toleo kwa kila mali ya programu inayozalishwa na mradi, ukifuata kawaida ya uainishaji thabiti au mpango wa nambari. Mifano ni pamoja na SemVer, CalVer, au kitambulisho cha git commit.

    Each release is a version-named tag and GitHub Release, and its assets carry the version in their names: monte3l-groundwork-<version>.tgz and its .sigstore.json bundle. The release workflow adds an SBOM (.cdx.json) from the next release.


    Ya kutosha kwa nishani!

    Mradi LAZIMA ufafanue sera ya kudhibiti siri na ushahidi unaotumika na mradi. Sera inapaswa kujumuisha mwongozo wa kuhifadhi, kufikia, na kuzungusha siri na ushahidi. [OSPS-BR-07.02]
    Eleza jinsi siri na ushahidi vinavyodhibitiwa na kutumika ndani ya mradi. Hii inapaswa kujumuisha maelezo ya jinsi siri zinavyohifadhiwa (k.m., kwa kutumia zana ya usimamizi wa siri), jinsi ufikiaji unavyodhibitiwa, na jinsi siri zinavyozungushwa au kusasishwa. Hakikisha kwamba habari nyeti haziingizwi kwa msimbo katika msimbo wa chanzo au kuhifadhiwa katika mifumo ya udhibiti wa toleo.

    SECURITY.md, "Secrets and credentials", states what the project does not store (no npm token, no signing key, no personal access token), inventories every secret with where it is stored and what uses it, and sets rules for storing (narrowest GitHub secret scope, environment secrets restricted to main), accessing (the two organization owners, with 2FA) and rotating (on exposure, at most one-year expiries, yearly replacement of non-expiring keys).


    Ya kutosha kwa nishani!

    Mradi ulipotoa toleo, nyaraka za mradi LAZIMA ziwe na maelekezo ya kuthibitisha uadilifu na uhalali wa mali za toleo. [OSPS-DO-03.01]
    Maelekezo katika mradi yanapaswa kuwa na habari kuhusu teknolojia iliyotumika, amri za kuendesha, na matokeo yanayotarajiwa. Inapowezekana, epuka kuhifadhi nyaraka hizi katika mahali pamoja na mfumo wa ujenzi na utoaji wa toleo ili kuepuka ukiukaji mmoja kuhatarisha programu na nyaraka za kuthibitisha uadilifu wa programu.

    npm provenance (Sigstore-backed, OIDC-issued, no long-lived key) plus a build-provenance attestation attached to the GitHub Release; see https://github.com/monte3l/m3l-groundwork/blob/main/SECURITY.md#verifying-releases for verification instructions. [signed_releases]


    Ya kutosha kwa nishani!

    Mradi unapotoa toleo, nyaraka za mradi LAZIMA ziwe na maelekezo ya kuthibitisha utambulisho unaotarajiwa wa mtu au mchakato unaothibitisha toleo la programu. [OSPS-DO-03.02]
    Utambulisho unaotarajiwa unaweza kuwa katika muundo wa vitambulisho vya funguo vilivyotumika kusaini, mtoa na utambulisho kutoka cheti cha sigstore, au aina nyingine zinazofanana. Inapowezekana, epuka kuhifadhi nyaraka hii mahali palipo sawa na mirija ya kujenga na kutoa ili kuepuka ukiukaji mmoja kuhatarisha programu na nyaraka za kuthibitisha uadilifu wa programu.

    npm provenance (Sigstore-backed, OIDC-issued, no long-lived key) plus a build-provenance attestation attached to the GitHub Release; see https://github.com/monte3l/m3l-groundwork/blob/main/SECURITY.md#verifying-releases for verification instructions. [signed_releases]


    Ya kutosha kwa nishani!

    Mradi unapotoa toleo, nyaraka za mradi LAZIMA zijumuishe kauli ya maelezo kuhusu wigo na muda wa msaada kwa kila toleo. [OSPS-DO-04.01]
    Ili kuwasilisha wigo na muda wa msaada kwa rasilimali za programu zilizotolewa za mradi, mradi unapaswa kuwa na faili ya SUPPORT.md, sehemu ya "Msaada" katika SECURITY.md, au nyaraka nyingine zinazoweka wazi mzunguko wa maisha wa msaada, ikijumuisha muda unaotarajiwa wa msaada kwa kila toleo, aina za msaada zinazotolewa (k.m., marekebisho ya hitilafu, sasisho za usalama), na sera au taratibu yoyote husika ya kupata msaada.

    SECURITY.md, "Scope and duration of support", states what is covered (the latest 1.x release and the /customize plugin as it stands on main) and that a release is supported until the next release in its line is published. There is no fixed calendar duration and no long-term-support line.


    Ya kutosha kwa nishani!

    Mradi unapotoa toleo, nyaraka za mradi LAZIMA zitoe kauli ya maelezo ya wakati matoleo au matoleo hayatapokea tena sasisho za usalama. [OSPS-DO-05.01]
    Ili kuwasilisha wigo na muda wa msaada kwa marekebisho ya usalama, mradi unapaswa kuwa na SUPPORT.md au nyaraka nyingine zinazoweka wazi sera ya mradi ya sasisho za usalama.

    SECURITY.md, "Scope and duration of support", states that once a newer release in its line is published, the superseded release receives no fixes, security fixes included, and that the remedy is to upgrade.


    Ya kutosha kwa nishani!

    Nyaraka za mradi LAZIMA ziwe na sera kwamba washirikiano wa msimbo wanakaguliwa kabla ya kupewa ruhusa za juu zaidi za rasilimali nyeti. [OSPS-GV-04.01]
    Chapisha sera inayoweza kutekelezwa katika nyaraka za mradi inayohitaji washirikiano wa msimbo kupimwa na kuidhinishwa kabla ya kupewa ruhusa zilizopandishwa kwa rasilimali nyeti, kama vile idhini ya kuunganisha au ufikiaji kwa siri. Inashauriwa kwamba upimaji ujumuishe kuanzisha mfululizo wa utambulisho unaoweza kuhalalishwa kama vile kuthibitisha ushirikiano wa mchangiaji na shirika linalojulikana na kuaminika.

    GOVERNANCE.md#granting-access is the policy: only an org owner grants access, with the other owner's agreement, after a track-record check and an out-of-band identity check; access starts at triage; either owner can revoke it; access is reviewed at least once a year.


    Ya kutosha kwa nishani!

    Mradi unapotoa toleo, rasilimali zote za programu zilizotolewa na zilizokusanywa LAZIMA zikabidhi pamoja na orodha ya bili ya programu. [OSPS-QA-02.02]
    Inashauriwa kuzalisha SBOM kiotomatiki wakati wa kujenga kwa kutumia zana ambayo imepimwa kwa usahihi. Hii huwezesha watumiaji kuingiza data hii kwa njia ya kiwango pamoja na miradi mingine katika mazingira yao.

    Each release's GitHub Release carries a CycloneDX 1.6 SBOM (monte3l-groundwork-<version>.tgz.cdx.json), attested with actions/attest and verifiable with gh attestation verify --predicate-type https://cyclonedx.org/bom. See SECURITY.md#verifying-releases.


    Ya kutosha kwa nishani!

    Mradi unapotoa toleo linalojumuisha hifadhi nyingi za chanzo cha msimbo, miradi yote midogo LAZIMA ilazimishe mahitaji ya usalama ambayo ni kali au kali zaidi kuliko msimbo wa msingi. [OSPS-QA-04.02]
    Hifadhi yoyote ya ziada ya msimbo wa miradi midogo iliyozalishwa na mradi na kukusanywa katika toleo lazima ilazimishe mahitaji ya usalama kama inavyolingana na hali na nia ya msimbo husika. Kwa kuongeza kufuata mahitaji ya msingi wa OSPS yanayolingana, hii inaweza kujumuisha kuhitaji ukaguzi wa usalama, kuhakikisha kuwa haina udhaifu, na kuhakikisha kuwa haina masuala ya usalama yanayojulikana.

    No release is built from more than one source repository; the vendored m3l-design copy lives in this repository (GOVERNANCE.md, Related repositories).


    Ya kutosha kwa nishani!

    Nyaraka za mradi LAZIMA zieleze kwa uwazi ni lini na jinsi gani majaribio yanaendeshwa. [OSPS-QA-06.02]
    Ongeza sehemu kwenye nyaraka za kuchangia inayoweka wazi jinsi ya kutekeleza majaribio kienyeji na jinsi ya kutekeleza majaribio katika mirija ya CI/CD. Nyaraka zinapaswa kuweka wazi majaribio yanajaribu nini na jinsi ya kutafsiri matokeo.

    CONTRIBUTING.md, "Test environments and how tests run", lists the three kinds of test, every environment they run in (local, ubuntu-latest, macos-latest, Node's current line, and the manual soak workflow on Linux x64, Linux arm64 and macOS), what triggers each, and how to read the results. Windows is not covered.


    Ya kutosha kwa nishani!

    Nyaraka za mradi LAZIMA zijumuishe sera kwamba mabadiliko yote makubwa kwenye programu inayotengenezwa na mradi yanapaswa kuongeza au kusasisha majaribio ya utendaji katika seti ya majaribio otomatiki. [OSPS-QA-06.03]
    Ongeza sehemu kwenye nyaraka za kuchangia inayoweka wazi sera ya kuongeza au kusasisha majaribio. Sera inapaswa kuweka wazi ni nini kinachojumuisha mabadiliko makubwa na majaribio yapi yanapaswa kuongezwa au kusasishwa.

    https://github.com/monte3l/m3l-groundwork/blob/main/CONTRIBUTING.md#scope-of-a-pr. [test_policy_mandated]


    Ya kutosha kwa nishani!

    Wakati kuruhusu kumefanywa kwa tawi kuu, mfumo wa udhibiti wa toleo la mradi LAZIMA uhitaji angalau idhini moja ya binadamu asiye mwandishi ya mabadiliko kabla ya kuunganisha. [OSPS-QA-07.01]
    Sanidi mfumo wa udhibiti wa toleo la mradi kuhitaji angalau idhini moja ya binadamu asiye mwandishi ya mabadiliko kabla ya kuunganisha katika toleo au tawi kuu. Hii inaweza kupatikana kwa kuhitaji ombi la kuvuta kupimwa na kuidhinishwa na angalau mshirikiano mmoja mwingine kabla ya kunaweza kuunganishwa.

    The main ruleset requires one approving review from someone other than the author (required_approving_review_count=1, stale approvals dismissed on push, no bypass actors). See GOVERNANCE.md#decision-making.


    Ya kutosha kwa nishani!

    Mradi unapotoa toleo, mradi LAZIMA ufanye ufuatiliaji wa tisho na uchambuzi wa uso wa shambulio ili kuelewa na kulinda dhidi ya mashambulizi kwenye njia za msimbo muhimu, majukumu, na mwingiliano ndani ya mfumo. [OSPS-SA-03.02]
    Ufuatiliaji wa tisho ni shughuli ambapo mradi unaangalia msimbo, michakato na miundombinu inayohusiana, viunganishi, vipengele muhimu na "kufikiria kama kibogoyo" na kufanya mapendekezo ya jinsi mfumo unaweza kuvunjwa au kuhatarisha. Kila tisho iliyotambuliwa imeorodheshwa ili mradi uweze kufikiria jinsi ya kuepuka au kufunga pengo/udhaifu wowote unaoweza kutokea kwa kujihadhari. Hakikisha hii imesasishwa kwa vipengele vipya au mabadiliko ya kuvunja.

    https://github.com/monte3l/m3l-groundwork/blob/main/docs/assurance-case.md. [assurance_case]


    Ya kutosha kwa nishani!

    Udhaifu wowote katika vipengele vya programu usioathiri mradi LAZIMA uzingatiwe katika hati ya VEX, ikiongeza kwenye ripoti ya udhaifu maelezo ya kutoweza kutumika vibaya (non-exploitability). [OSPS-VM-04.02]
    Weka mfumo wa mlisho wa VEX unaowasiliana hali ya utumiaji vibaya wa udhaifu unaojulikana, ikiwa ni pamoja na maelezo ya tathmini au marekebisho yoyote yaliyowekwa kusimamisha msimbo ulio na udhaifu usiotekelezwa.

    docs/m3l-groundwork.openvex.json is an OpenVEX document with a not_affected statement (component_not_present) for each of the 13 advisories recorded in docs/security-review.md, for versions 1.0.0 to 1.0.2; SECURITY.md, "Vulnerabilities that do not affect the project", explains its scope and upkeep. No vulnerability is currently open against any component the project ships or uses.


    Ya kutosha kwa nishani!

    Nyaraka za mradi LAZIMA zijumuishe sera inayofafanua kiwango cha chini cha kurekebisha matokeo ya SCA yanayohusiana na udhaifu na leseni. [OSPS-VM-05.01]
    Andika sera katika mradi inayofafanua kiwango cha marekebisho ya matokeo ya SCA yanayohusiana na udhaifu na leseni. Jumuisha mchakato wa kutambua, kutanguliza, na kurekebisha matokeo haya.

    SECURITY.md, "Dependency and code-scanning findings", Remediation thresholds: critical or high SCA vulnerabilities block the PR that introduces them and are fixed within 60 days if published against a locked dependency; medium within 60 days; low with no deadline. A license outside the allow-list in dependency-review.yml blocks the PR that adds it, and one found on a locked dependency is fixed within 60 days. The process section covers identifying, prioritizing and remediating.


    Ya kutosha kwa nishani!

    Nyaraka za mradi LAZIMA zijumuishe sera ya kushughulikia ukiukaji wa SCA kabla ya toleo lolote. [OSPS-VM-05.02]
    Andika sera katika mradi wa kushughulikia matokeo ya Uchambuzi wa Muundo wa Programu yanayotumika kabla ya toleo lolote, na ongeza ukaguzi wa hali unaothibitisha kufuata sera hiyo kabla ya toleo.

    SECURITY.md, "Dependency and code-scanning findings", sets the policy: a critical or high advisory in a dependency blocks a PR and blocks any release, and release.yml's pack job runs pnpm audit and npm audit before anything is built.


    Ya kutosha kwa nishani!

    Mabadiliko yote kwenye msingi wa msimbo wa mradi LAZIMA yatathminiwe kiotomatiki dhidi ya sera iliyoandikwa kuhusu utegemezi hasidi na udhaifu unaojulikana katika utegemezi, kisha kuzuiliwa endapo kuna ukiukaji, isipokuwa pale ilipotangazwa na kufichwa kama isiyoweza kutumika vibaya. [OSPS-VM-05.03]
    Unda ukaguzi wa hali katika mfumo wa kudhibiti toleo la mradi unaoendesha zana ya Uchambuzi wa Muundo wa Programu kwenye mabadiliko yote ya msingi wa msimbo. Hitaji kwamba ukaguzi wa hali upite kabla mabadiliko kusanywa.

    https://github.com/monte3l/m3l-groundwork/blob/main/.github/workflows/dependency-review.yml fails a PR on a high-severity finding; GitHub CodeQL and Dependabot alerts cover the rest. [dependency_monitoring]


    Ya kutosha kwa nishani!

    Nyaraka za mradi LAZIMA zijumuishe sera inayofafanua kiwango cha chini cha kurekebisha matokeo ya SAST. [OSPS-VM-06.01]
    Andika sera katika mradi inayofafanua kiwango cha marekebisho ya matokeo ya Upimaji wa Usalama wa Programu Tuli (SAST). Jumuisha mchakato wa kutambua, kutanguliza, na kurekebisha matokeo haya.

    SECURITY.md, "Dependency and code-scanning findings", Remediation thresholds: a new CodeQL alert of error severity or critical or high security severity blocks the PR; one in merged code at medium or higher is fixed within 60 days of triage.


    Ya kutosha kwa nishani!

    Mabadiliko yote kwenye msingi wa msimbo wa mradi LAZIMA yatathminiwe kiotomatiki dhidi ya sera iliyoandikwa kuhusu udhaifu wa usalama na kuzuiliwa endapo kuna ukiukaji isipokuwa pale ilipotangazwa na kufichwa kama isiyoweza kutumika vibaya. [OSPS-VM-06.02]
    Unda ukaguzi wa hali katika mfumo wa kudhibiti toleo la mradi unaoendesha zana ya Upimaji wa Usalama wa Programu Tuli (SAST) kwenye mabadiliko yote ya msingi wa msimbo. Hitaji kwamba ukaguzi wa hali upite kabla mabadiliko kusanywa.

    CodeQL default setup analyzes every push and PR, and the CodeQL check is a required status check on main. By GitHub's default it fails on new alerts of error severity or critical or high security severity.



Unaweza kutumia zana na mifumo ya AI kupendekeza mabadiliko kupitia URL rahisi, kama vile https://www.bestpractices.dev/sw/projects/14937/choose/edit?osps_ac_01_01_status=Met&osps_ac_01_01_justification=GitHub+enforced. Angalia mfumo wetu wa mapendekezo ya otomatiki kwa jinsi ya kufanya hivyo. Data hii inapatikana chini ya Community Data License Agreement – Permissive, Version 2.0 (CDLA-Permissive-2.0). Hii inamaanisha kuwa Mpokeaji wa Data anaweza kushiriki Data, na au bila marekebisho, mradi Mpokeaji wa Data anapatanisha maandishi ya mkataba huu na Data iliyoshirikiwa. Tafadhali tambua Enrico Lionello na wachangiaji wa nishani ya Mazoea Bora ya OpenSSF.

Ingizo la nishani ya mradi linamilikiwa na: Enrico Lionello.
Ingizo liliundwa siku 2026-09-25 19:53:20 UTC, iliyosasishwa mara ya mwisho siku 2026-10-19 07:02:09 UTC. Ilipata mara ya mwisho nishani ya kupita siku 2026-09-27 11:47:23 UTC.