docarray

遵循以下最佳实践的项目将能够自愿的自我认证，并显示他们已经实现了核心基础设施计划（OpenSSF）徽章。

如果这是您的项目，请在您的项目页面上显示您的徽章状态！徽章状态如下所示： 项目6554的徽章级别为gold 这里是如何嵌入它：

这些是黄金级别条款。您还可以查看通过或白银级别条款。

        

 基本 5/5 ●

  • 识别

    🧬 The data structure for unstructured multimodal data · Neural Search · Vector Search · Document Store

  • 先决条件


    足够获得徽章！

    该项目必须拥有银级徽章。 [achieve_silver]

  • 项目监督


    足够获得徽章！

    项目必须具有2个或更多的“公交车因子”。 (需要网址) [bus_factor]

    We have 3 main maintainers. Actively contributing and knowing the codebase:

    • Joan Fontanals Martínez
    • Sami Jaghouar
    • Johannes Messner

    https://github.com/docarray/docarray/blob/main/GOVERNANCE.md


    足够获得徽章！

    该项目必须至少有两个不相关的重要贡献者。 (需要网址) [contributors_unassociated]

    We have contributors from: - Jina: Joan Fontanals Martinez (https://github.com/JoanFM), - Weaviate: Shukri: https://github.com/hsm207 - Epsilla: Tony Yang https://github.com/tonyyanga - Others: Naymul Islam https://github.com/ai-naymul


  • 其他


    足够获得徽章！

    项目必须在每个源文件中包含许可证声明。这可以通过在每个文件开头附近的注释中加入以下内容来实现： SPDX-License-Identifier: [SPDX license expression for project]。 [license_per_file]

    All the files in the repo contain it:

    Example: https://github.com/docarray/docarray/blob/main/docarray/__init__.py


  • 公开的版本控制的源代码存储库


    足够获得徽章！

    必须使用通用的分布式版本控制软件（例如，git，mercurial）作为项目的源代码存储库。 [repo_distributed]

    Repository on GitHub, which uses git. git is distributed.


    足够获得徽章！

    该项目必须清楚地识别新的或临时贡献者可以执行的小型任务。 (需要网址) [small_tasks]

    https://github.com/docarray/docarray/issues

    We have issues labeled as good-first-issues


    足够获得徽章！

    项目必须要求开发人员使用双因素身份验证（2FA）来更改中央存储库或访问敏感数据（如私密漏洞报告）。这种2FA机制可以使用没有密码学机制的方案，如SMS（短消息），尽管不推荐。 [require_2FA]

    In Github settings the box: Require two-factor authentication for everyone in the DocArray organization. is ticked.


    足够获得徽章！

    项目的双因素身份认证（2FA）应该使用加密机制来防止仿冒。基于短消息服务（SMS）的2FA本身不符合此标准，因为它不被加密。 [secure_2FA]

    The members do use these mechanisms. There is no specific method for the project.


  • 编码标准


    足够获得徽章！

    该项目必须记录其代码检视需求，包括代码检视是如何进行的，必须检查的内容以及哪些是可接纳的内容。 (需要网址) [code_review_standards]

    https://github.com/docarray/docarray/blob/main/CONTRIBUTING.md


    足够获得徽章！

    该项目必须至少有50％的修改（作者之外的人提出的）在发布之前审查，以确定是否是一个有价值的修改，并且没有已知的问题，会反对其包含 [two_person_review]

    The project mostly requires one of the members of the Technical comittee or from the major contributors to be reviewed


  • 可工作的构建系统


    足够获得徽章！

    该项目必须具有可重复构建。如果没有发生构建（例如，直接使用源代码而不是编译的脚本语言），请选择“不适用”（N/A）。 (需要网址) [build_reproducible]

    DocArray versions lead to a Python package stored in Pypi repositories linked to the version entry in the source code. https://pypi.org/project/docarray/


  • 自动测试套件


    足够获得徽章！

    测试套件必须以该语言的标准方式进行调用。 (需要网址) [test_invocation]

    The test suite can be invoked by pytest and documentation how to run tests is to be found in https://github.com/docarray/docarray/blob/main/CONTRIBUTING.md


    足够获得徽章！

    该项目必须实施持续集成，将新的或更改的代码经常集成到中央代码库中，并对结果进行自动化测试。 (需要网址) [test_continuous_integration]

    The project has Continuous Integration pipelines that check the quality of the PR for every PR and for every merge.https://github.com/docarray/docarray/blob/main/.github/workflows/ci.yml


    足够获得徽章！

    如果有至少一个FLOSS工具可以以所选语言度量此条款，该项目的FLOSS自动测试套件必须具有至少90％语句覆盖率。 [test_statement_coverage90]

    https://app.codecov.io/gh/docarray/docarray

    This shows close to 90% but the lines that are not counted are mostly unreachable


    足够获得徽章！

    如果有至少一个FLOSS工具可以以所选语言度量此条款，该项目的FLOSS自动测试套件必须具有至少80％分支覆盖率。 [test_branch_coverage80]

    https://app.codecov.io/gh/docarray/docarray


  • 使用基础的良好加密实践

    请注意，某些软件不需要使用加密机制。

    足够获得徽章！

    项目生成的软件必须支持所有网络通信的安全协议，如SSHv2或更高版本，TLS1.2或更高版本（HTTPS），IPsec，SFTP和SNMPv3。默认情况下，FTP，HTTP，Telnet，SSLv3或更早版本以及SSHv1等不安全协议必须被禁用，只有在用户专门配置时才启用。如果项目生成的软件不支持网络通信，请选择“不适用”（N/A）。 [crypto_used_network]

    足够获得徽章！

    由项目生成的软件必须，如果支持或使用TLS，至少支持TLS版本1.2。请注意，TLS的前身称为SSL。如果软件不使用TLS，请选择“不适用”（N/A）。 [crypto_tls12]

  • 安全交付防御中间人（MITM）的攻击


    足够获得徽章！

    项目网站，存储库（如果可通过网络访问）和下载站点（如果单独）必须包括具有非允许值的密钥加固头。 (需要网址) [hardened_site]

    The repository is in github :

    You can check here https://securityheaders.com/?q=https%3A%2F%2Fgithub.com%2Fdocarray%2Fdocarray&followRedirects=on


  • 其他安全问题


    足够获得徽章！

    该项目必须在过去5年内进行安全审查。此审查必须考虑安全需求和安全边界。 [security_review]

    The TAC members have done a security review and all the warnings from analysis and dependabots are analyzed and worked on.


    足够获得徽章！

    加固机制必须用于项目生产的软件，以便软件缺陷不太可能导致安全漏洞。 (需要网址) [hardening]

    not applicable because we work at a higher level than this. This is handled by our dependencies.


  • 动态代码分析


    足够获得徽章！

    必须在发布之前，至少将一个动态分析工具应用于软件任何候选发布的主要生产版本。 [dynamic_analysis]

    Flake8 ans static analysis for python is enough since the language is memory safe


    足够获得徽章！

    项目应该在其生成的软件中包含许多运行时断言，并在动态分析期间检查这些断言。 [dynamic_analysis_enable_assertions]

    For Python as it is a safe programming language these assertions do not apply



此数据在知识共享署名3.0或更高版本许可证（CC-BY-3.0 +） 下可用。所有内容都可以自由分享和演绎，但必须给予适当的署名。请署名为samsja和OpenSSF最佳实践徽章贡献者。

项目徽章条目拥有者： samsja.
最后更新于 2022-10-05 06:46:53 UTC, 最后更新于 2024-02-09 11:54:21 UTC。 最后在 2022-10-07 11:17:13 UTC 获得通过徽章。

后退