Headings from h1
through h6
are constructed with a #
for each level:
# h1 Heading
## h2 Heading
### h3 Heading
You are encouraged to add “badges” such as Travis CI’s image
or Code Climate’s
. See this blogpost for more information
At the top of the file there should be a short introduction and/ or overview that explains what the project is. This description should match descriptions added for package managers (Gemspec, package.json, etc.)
Pull requests are greatly appreciated and are what makes opensource great. Here's a quick guide:
git checkout -b my-new-feature
)git commit -am 'Add some feature'
)git push origin my-new-feature
)All notable changes to this project will be documented in this file.
This project adheres to Keep a CHANGELOG and Semantic Versioning
# This file is for unifying the coding style for different editors and IDEs usin EditorConfig | |
# http://EditorConfig.org | |
# All EditorConfig properties: | |
# https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties | |
root = true | |
# global settings | |
[*] |
<project xmlns="http://maven.apache.org/POM/4.0.0" | |
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | |
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 | |
http://maven.apache.org/maven-v4_0_0.xsd"> | |
<modelVersion>4.0.0</modelVersion> | |
<groupId>com.gordondickens.sample</groupId> | |
<artifactId>sample-parent</artifactId> | |
<version>1.0.0</version> | |
<packaging>pom</packaging> |
--- | |
# ^^^ YAML documents must begin with the document separator "---" | |
# | |
#### Example docblock, I like to put a descriptive comment at the top of my | |
#### playbooks. | |
# | |
# Overview: Playbook to bootstrap a new host for configuration management. | |
# Applies to: production | |
# Description: | |
# Ensures that a host is configured for management with Ansible. |