🔍 Explore Our Guides

Explore our guides via the categories below or the left-hand navigation. You may also search our guides.

Software Lifecycle

Covers the entire process of software development: from code development, testing, building, security to deployment and delivery.

Governance

Covers governance topics like governance frameworks, standards for contributions, triaging and other ideas.

Information Sharing

Focuses on project information sharing best practices, including documentation, communication channels, and other topics.

Getting Started

Not sure where to begin? Start here with our checklist.

---

Search

GOVERNANCE.md

A governance model template seeking to generalize how most government-sponsored open source projects can expect to operate in the open source arena.

Tags:GovernanceTemplatesRepository SetupGithub

Secrets Detection

Detect-secrets is a security tool that scans code repositories to identify and prevent the accidental inclusion of sensitive information, such as API keys or passwords, by utilizing various detection techniques.

Tags:Software LifecycleSecurityTestingTools

README.md

A template that can be used to help developers and users understand your repository's project code concisely and clearly.

Tags:CommunicationDocumentationRepository SetupTemplatesGithub

Issue Ticket Templates

Issue tickets templates helping development teams keep the language of bug, feature, and other types of issues readable and consistent.

Tags:GovernanceTemplatesRepository SetupGithub

Change Log

A guide on creating and maintaining a human-readable change log for software development projects, emphasizing the importance of a `CHANGELOG.md` file.

Tags:DocumentationVersioningTemplatesRepository SetupGithub

Documentation Hosts

A guide on possible use cases and recommended tools for hosting various types of documentation with a call for contributions.

Tags:DocumentationTrade StudiesTools

Pull Requests

A guide outlining how to implement a pre-filled pull request template to provide guidance to potential contributors on GitHub.

Tags:GithubTemplatesGovernanceRepository Setup

Code of Conduct

A guide on how to create and implement a code of conduct for project teams, with a specific recommendation to use the Contributor Covenant.

Tags:GovernanceRepository SetupGithubTemplates

Contributing Guide

A detailed guide about creating a contributing guide for your project, featuring a customizable template and instructions on how to use it.

Tags:TemplatesGovernanceRepository SetupGithubTemplates

Python Starter Kit

A guide to a complete, deployment-ready Python 3 application that's bundled into a reusable template repository for quick implementation, with integrated build, release, and publish on GitHub.

Tags:PythonTemplatesRepository SetupContinuous IntegrationGithub

Continuous Integration Frameworks

An overview of different continuous integration frameworks and their use cases.

Tags:ToolsContinuous IntegrationTrade Studies

Reference Architectures

A high-level reference guide for the implementation of continuous integration best practices, detailing structure, component interrelationships, and processes.

Tags:Continuous IntegrationTestingVersioningDevops

Continuous Testing

An extensive list of resources and tools for continuous testing including module testing, service endpoint testing, performance testing, and mobile testing among others.

Tags:TestingTools

GitHub Security Best Practices

Recommendations for enabling GitHub security features for repositories, including using GitHub native tools like CodeQL, code scanning and more.

Tags:Software LifecycleSecurityTestingTools

Metrics Tracking

Recommendations for metrics collection and an installation tool for Apache DevLake.

Tags:Software LifecycleMetricsTools

Container Vulnerability Scanning

A guide to scanning containers and container repositories for security vulnerabilities both manually and automatically using Grype.

Tags:Software LifecycleSecurityVulnerability ScanningTools

Continuous Delivery

A guide for setting up a continuous delivery pipeline, automating release builds to external repositories.

Tags:Continuous DeliveryAutomationPipelinesSoftware Lifecycle