Skip to content

Latest commit

 

History

History
151 lines (109 loc) · 3.74 KB

intridea.md

File metadata and controls

151 lines (109 loc) · 3.74 KB
Raw

Intridea Style

The Intridea style changelog was pioneered on the Hashie project. It has many elements that can you use and prevents some other elements as follows.

Titles

✅ You can have up to four levels of titles

# This is a title for my changelog
## lower case also works and so do numbers 123
### Colons: They are awesome
#### Probably not used all that often

❌ Only letters (a-z), numbers, underscores and colons are allowed in titles

#### Emoji is not allowed 😢
#### Hyphens are not allowed thus sugar-free is not valid
#### Multiple sentences. Are not allowed
#### Commas, neither
#### No accented characters sorry Beyoncé

❌ Titles must start with a leading space

#This is not valid

✅ You can place your titles inside a single parens

# (This is allowed)
## [This is allowed]
### {This is also allowed}

❌ Parens in a title must match, and you can only have one set

# (Not valid
## {Not valid)
### Not valid ()
#### [] Not valid
#### ((Not valid))

✅ You can have a semantic-versioning compatible version number

# 1.0.0
## 1.0.0-alpha
### (3.2.1-beta+reallybuggy.1)

❌ Version numbers which do not follow semantic-versioning are not allowed

# 01.0.0.notvalid

❌ You cannot combine version numbers with other text

# Not valid 1.0.0
# Not valid (1.0.0)

✅ You can include an ISO 8601-formatted date along with a version, inside or outside parens

# 1.0.0 2019
## 1.0.0 (2019-12-31)
### (1.0.0) (2019/12/31)
#### (1.0.0) 20191231

❌ No other date or time formats are allowed

# 1.0.0 (2019-12)
# 1.0.0 (2019-W1)
# 1.0.0 (2019-04-28T09:21:58Z)
# 1.0.0 (31/12/2019)

❌ Dates cannot be combined with normal titles

# Not valid (2019/12/31)

Changelog entries

✅ Under each title, you can have changelog entries in the format: * {optional link to GitHub pull request that must be followed by a colon} {a single sentence of text description} - {author github link}.:

* Entry without a PR link - [@ivoanjo](https://github.com/ivoanjo).
* [#1](https://github.com/dblock/danger-changelog/pull/1): Entry with a PR link - [@dblock](https://github.com/dblock).
* Yes, this is a weird entry, but it's still valid! Also Beyoncé is welcome here, as is 松本 行弘 and our nice emojis 👍 - [@ivoanjo](https://github.com/ivoanjo).

❌ Entry descriptions need to start with an uppercase A-Z letter

* not valid - [@ivoanjo](https://github.com/ivoanjo).
* いいえ - [@ivoanjo](https://github.com/ivoanjo).
* ❌ - [@ivoanjo](https://github.com/ivoanjo).
* [#1](https://github.com/dblock/danger-changelog/pull/1): not valid - [@dblock](https://github.com/dblock).

❌ GitHub pull request links need to be followed with a colon

* [#1](https://github.com/dblock/danger-changelog/pull/1) Not valid - [@dblock](https://github.com/dblock).

❌ Only links to GitHub are allowed, and only using https

* No GitLab - [@ivoanjo](https://gitlab.com/ivoanjo).
* No insecure http - [@ivoanjo](http://github.com/ivoanjo).
* [#1](https://you-get-the-point.com): Entry with a PR link - [@dblock](https://github.com/dblock).

❌ Only a single sentence is allowed

* Did stuff. Then more stuff - [@ivoanjo](https://github.com/ivoanjo).

❌ A dash needs to separate the text description from the author

* Missing a dash here ➡️ [@ivoanjo](https://github.com/ivoanjo).

❌ An entry must end with a period

* Not valid - [@ivoanjo](https://github.com/ivoanjo)

Blank lines

✅ You can have them