pointblank

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

如果这是您的项目,请在您的项目页面上显示您的徽章状态!徽章状态如下所示: 项目4310的徽章级别为passing 这里是如何嵌入它:

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

        

 基本 4/5

  • 识别

    The pointblank R package lets people easily validate data in data frames, 'tibble' objects, Spark DataFrames, and database tables (e.g., 'PostgreSQL' and 'MySQL'). Validation pipelines can be made using easily-readable, consecutive validation steps. Upon execution of the validation plan, several reporting options are available. The package also facilitates an information management workflow, where the aim is to record, collect, and generate useful information on data tables.

  • 先决条件


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

  • 项目监督


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

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

    There are currently two unassociated significant contributors involved in the project (https://github.com/rich-iannone/pointblank/blob/18688d816c23651682bb83e5e41d0591880d16c1/DESCRIPTION#L13).


  • 其他


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

    Each source file contains information on the copyright holder and also a brief license statement (with a link to the full license information). An example is available at: https://github.com/rich-iannone/pointblank/blob/master/R/interrogate.R


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


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

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



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

    Each issue in the Issues page is labeled and certain issue may be labeled with ‘Help Wanted’. Further to this, the predicted difficulty of working on an issue (which could be a big fix, a new feature, documentation, etc.) and the predicted effort level are given as separate labels. In this way, potential contributors could filter the issues list to those that require help by difficulty and effort level. An example of an issue with these labels is https://github.com/rich-iannone/pointblank/issues/16.



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


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

  • 编码标准


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


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

  • 可工作的构建系统


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

    R packages are built during installation and reproducibility for this (along with quality checks) is done through GitHub actions (https://github.com/rich-iannone/pointblank/actions?query=workflow%3AR-CMD-check) for every commit and through CRAN’s automated build/check system (https://cran.r-project.org/web/checks/check_results_pointblank.html) for every release.


  • 自动测试套件


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

    The tests are in the standard format for R packages. Using the testthat package (http://github.com/r-lib/testthat), it is easy to run the tests. Standard R package quality checks run these tests, as do testthat::test_package() and devtools::test(). This is the de facto standard for R packages.



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

    The pointblank package uses GitHub Actions to run R CMD check (a comprehensive set of tests for the package) with each commit and pull request (https://github.com/rich-iannone/pointblank/actions?query=workflow%3AR-CMD-check). Merging doesn't typically occur unless all CI checks pass.



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

    One of the GitHub Actions workflows checks for code coverage from the test suite and sends the report to a third-party for further reporting and badge generation. We display the code coverage badge on the project README. Code coverage through this test suite does provide at least 90% coverage and it is a policy to have code coverage be above 90% at all times.



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

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

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

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

    This is out of scope for pointblank and other R packages that do not explicitly focus on privacy and security.



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

    This is out of scope for pointblank and other R packages that do not explicitly focus on privacy and security.


  • 安全交付防御中间人(MITM)的攻击


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

    // X-Content-Type-Options was not set to "nosniff".


  • 其他安全问题


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


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

    This is out of scope for pointblank and other R packages that do not explicitly focus on privacy and security.


  • 动态代码分析


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

    The lintr package (https://github.com/jimhester/lintr) is invoked by a GitHub Actions workflow (https://github.com/rich-iannone/pointblank/blob/main/.github/workflows/lint.yaml) for every commit and pull request. If any lints are found, the maintainer is notified via email and CI correspondingly fails. This status is also transparent in the 'lint' badge shown in the project repository README.md (on GitHub) and in the project website (https://rich-iannone.github.io/pointblank/).



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

    Dynamic analysis is not required for pointblank. This is true for all R packages that are implemented entirely in R (without uses of C, C++, etc.).



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

项目徽章条目拥有者: Richard Iannone.
最后更新于 2020-09-30 13:14:57 UTC, 最后更新于 2022-02-02 03:54:59 UTC。 最后在 2020-09-30 14:41:58 UTC 获得通过徽章。

后退