cybercinch/dynamic-badges-action
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

📝 Add versioning notes

Browse Source
This commit is contained in:
Simon Schneegans
2020-08-16 06:22:15 +02:00
parent 7511d361a2
commit 0b15fcb256
1 changed files with 11 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -72,7 +72,7 @@ Gist Parameter | Description
`message` | Required. The right text of the badge. `message` | Required. The right text of the badge.
`labelColor` | The left color of the badge. `labelColor` | The left color of the badge.
`color` | The right color of the badge. `color` | The right color of the badge.
`isError` | The color will be red and cannot be overridde.n `isError` | The color will be red and cannot be overridden.
`namedLogo` | A logo name from [simpleicons.org](http://simpleicons.org/). `namedLogo` | A logo name from [simpleicons.org](http://simpleicons.org/).
`logoSvg` | An svg-string to be used as logo. `logoSvg` | An svg-string to be used as logo.
`logoColor` | The color for the logo. `logoColor` | The color for the logo.
@@ -124,4 +124,13 @@ Emoji | Description
:beetle: `:beetle:` | When you fixed a bug. :beetle: `:beetle:` | When you fixed a bug.
:twisted_rightwards_arrows: `:twisted_rightwards_arrows:` | When you merged a branch. :twisted_rightwards_arrows: `:twisted_rightwards_arrows:` | When you merged a branch.
:fire: `:fire:` | When you removed something. :fire: `:fire:` | When you removed something.
:truck: `:truck:` | When you moved / renamed something. :truck: `:truck:` | When you moved / renamed something.
## Version Numbers
Version numbers will be assigned according to the [Semantic Versioning](https://semver.org/) scheme.
This means, given a version number MAJOR.MINOR.PATCH, we will increment the:
1. MAJOR version when we make incompatible API changes,
2. MINOR version when we add functionality in a backwards compatible manner, and
3. PATCH version when we make backwards compatible bug fixes.