Skip to content

Instantly share code, notes, and snippets.

@arowla
Created November 18, 2015 20:31
Show Gist options
  • Save arowla/39c102f4f92fff9c9090 to your computer and use it in GitHub Desktop.
Save arowla/39c102f4f92fff9c9090 to your computer and use it in GitHub Desktop.
.about.yml Template
---
# .about.yml project metadata
#
# Short name that acts as the project identifier (required)
name:
# Full proper name of the project (required)
full_name:
# The type of content in the repo
# values: app, docs, policy
type:
# Describes whether a project team, working group/guild, etc. owns the repo (required)
# values: guild, working-group, project
owner_type:
# Name of the main project repo if this is a sub-repo; name of the working group/guild repo if this is a working group/guild subproject
parent:
# Maturity stage of the project (required)
# values: discovery, alpha, beta, live, sunset, transfer, end
stage:
# Description of the project
description:
# Tags that describe the project or aspects of the project
tags:
-
# Should be 'true' if the project has a continuous build (required)
# values: true, false
testable:
# Team members contributing to the project (required)
# Items:
# - github: GitHub user name
# id: Internal team identifier/user name
# role: Team member's role; leads should be designated as 'lead'
team:
-
# Partners for whom the project is developed
partners:
-
# Organizations or individuals who have adopted the project for their own use
# Items:
# - id: The name of the organization or individual
# url: A URL to the user's version of the project
users:
-
# Brief descriptions of significant project developments
milestones:
-
# Technologies used to build the project
stack:
-
# Brief description of the project's outcomes
impact:
# Services used to supply project status information
# Items:
# - name: Name of the service
# category: Type of the service
# url: URL for detailed information
# badge: URL for the status badge
services:
-
# Licenses that apply to the project and/or its components (required)
# Items by property name pattern:
# .*:
# name: Name of the license from the Software Package Data Exchange (SPDX): https://spdx.org/licenses/
# url: URL for the text of the license
licenses:
placeholder_label:
# Blogs or websites associated with project development
blog:
-
# Links to project artifacts
# Items:
# - url: URL for the link
# text: Anchor text for the link
links:
-
# URIs for points-of-contact
# Items:
# - url: URI for the link to
# text: Anchor text for the link
contact:
-
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment