OSPO Project Template

OSPO Project Template

28

A repository template for ospo.ch projects

Documentation
50
License
25
Best practices
15
Security
40
Legal
10
83
Documentation
These checks highlight opportunities to improve the documentation of your project.
failed
Governance
Document that explains how the governance and committer process works in the repository
Maintainers
The maintainers file contains a list of the current maintainers for the repository
Roadmap
Defines the high level overview of the project’s goals and deliverables ideally presented on a timeline
Website
A url that users can visit to learn more about your project
passed (5)
Show Hide
Adopters
List of organizations using this project in production or at stages of testing check docs
Changelog
A curated, chronologically ordered list of notable changes for each version
Code of conduct
Adopt a code of conduct to define community standards, signal a welcoming and inclusive project, and outline procedures for handling abuse
Contributing
A contributing file in your repository provides potential project contributors with a short guide to how they can help with your project
Readme
The readme file introduces and explains a project. It contains information that is commonly required to understand what the project is about
100
License
These checks ensure the project has compliant licensing.
failed
License scanning
Automatically identify, manage and address open source licensing issues
passed (2)
Show Hide
Compliance
The license is approved within the organization
License
The LICENSE file contains the repository license
100
Best practices
These checks evaluate recommended practices for the project.
failed
Developer Certificate of Origin
Mechanism for contributors to certify that they wrote or have the right to submit the code they are contributing.
OpenSSF Badge
The Open Source Security Foundation (OpenSSF) Best Practices badge is a way for Free/Libre and Open Source Software (FLOSS) projects to show that they follow best practices.
Scorecard Badge
Scorecard assesses open source projects for security risks through a series of automated checks. For more information about the Scorecard badge, [please see] (https://github.com/marketplace/actions/ossf-scorecard-action#scorecard-badge)
passed (6)
Show Hide
Messaging support available
A messaging platform allows to build up the community for the project
Contributor License Agreement
Defines the terms under which intellectual property has been contributed to a company/project.
GitHub Discussions
GitHub discussions enable better collaboration on the project
Issue Template
An Issue template helps with filing bugs on the project
Pull Request Template
A Pull Request template speeds up the approval process
Recent Release
The project should have released at least one version in the last year.
87
Security
These checks ensure that your project is following security practices.
failed
Dangerous Workflow
This check determines whether the project’s GitHub Action workflows has dangerous code patterns
Dependency Policy
Project should provide a dependencies policy that describes how dependencies are consumed and updated.
Dependency Update Tool
This check tries to determine if the project uses a dependency update tool, specifically dependabot or renovatebot
Software Bill of Materials
List of components in a piece of software, including licenses, versions, etc.
Security Policy
Clearly documented security processes explaining how to report security issues to the project.
Signed Release
This check tries to determine if the project cryptographically signs release artifacts.
Token Permissions
This check determines whether the project’s automated workflows tokens are set to read-only by default.
passed (3)
Show Hide
Binary artifacts
This check determines whether the project has generated executable (binary) artifacts in the source repository
Code Review
This check determines whether the project requires code review before pull requests (merge requests) are merged.
Maintained
This check determines whether the project is actively maintained
0
Legal
These checks ensure that your project is compliant with the legal guidelines.
failed
Trademark
A trademark should be applied to protect intellectual property