From 6809a6fc74e4ce26fd3b3a5815814637023f1f00 Mon Sep 17 00:00:00 2001 From: Tony Brix Date: Tue, 17 Nov 2020 16:24:53 -0600 Subject: [PATCH 1/7] chore(docs): update versioning information --- docs/PUBLISHING.md | 12 +++--------- docs/_document.html | 7 ++++++- 2 files changed, 9 insertions(+), 10 deletions(-) diff --git a/docs/PUBLISHING.md b/docs/PUBLISHING.md index 9b8f176210..6a377e4da1 100644 --- a/docs/PUBLISHING.md +++ b/docs/PUBLISHING.md @@ -8,14 +8,8 @@ Marked uses [semantic-release](https://github.com/semantic-release/semantic-rele ## Versioning -We follow [semantic versioning](https://semver.org) where the following sequence is true `[major].[minor].[patch]`; therefore, consider the following implications of the release you are preparing: +We follow [semantic versioning](https://semver.org) where the following sequence is true `[major].[minor].[patch]`: -1. **Major:** There is at least one change not deemed backward compatible. -2. **Minor:** There is at least one new feature added to the release. +1. **Major:** There is at least one change to the public API or a break from the [CommonMark](https://spec.commonmark.org/current/) or [GFM](https://github.github.com/gfm/) spec. +2. **Minor:** There is at least one new feature added to the public API. 3. **Patch:** No breaking changes, no new features. - -What to expect while Marked is a zero-major (0.x.y): - -1. The major will remain at zero; thereby, alerting consumers to the potentially volatile nature of the package. -2. The minor will tend to be more analogous to a `major` release. -3. The patch will tend to be more analogous to a `minor` release or a collection of bug fixes (patches). diff --git a/docs/_document.html b/docs/_document.html index 9884c1f0fb..bec1adc854 100644 --- a/docs/_document.html +++ b/docs/_document.html @@ -64,7 +64,12 @@

Marked Documentation

  • Code of Conduct
  • Authors
    • -
  • Publishing
    • +
  • + Publishing + +
  • License
    • From 004271011afc6ca89af8157cd9b666346507a005 Mon Sep 17 00:00:00 2001 From: Tony Brix Date: Tue, 17 Nov 2020 16:25:40 -0600 Subject: [PATCH 2/7] chore(license): add markedjs copyright --- LICENSE.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/LICENSE.md b/LICENSE.md index 64b41a0e46..4bd2d4a084 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -8,6 +8,7 @@ all code is your original work. `` ## Marked +Copyright (c) 2018+, MarkedJS (https://github.com/markedjs/) Copyright (c) 2011-2018, Christopher Jeffrey (https://github.com/chjj/) Permission is hereby granted, free of charge, to any person obtaining a copy @@ -30,8 +31,8 @@ THE SOFTWARE. ## Markdown -Copyright © 2004, John Gruber -http://daringfireball.net/ +Copyright © 2004, John Gruber +http://daringfireball.net/ All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: From 3b41f0224512c32d92969289bab85decde265c17 Mon Sep 17 00:00:00 2001 From: Tony Brix Date: Tue, 17 Nov 2020 16:26:02 -0600 Subject: [PATCH 3/7] chore(readme): remove deps badges --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 7f6f0bd9e1..9f48278366 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,6 @@ [![gzip size](https://badgen.net/badgesize/gzip/https://cdn.jsdelivr.net/npm/marked/marked.min.js)](https://cdn.jsdelivr.net/npm/marked/marked.min.js) [![install size](https://badgen.net/packagephobia/install/marked)](https://packagephobia.now.sh/result?p=marked) [![downloads](https://badgen.net/npm/dt/marked)](https://www.npmjs.com/package/marked) -[![dep](https://badgen.net/david/dep/markedjs/marked?label=deps)](https://david-dm.org/markedjs/marked) -[![dev dep](https://badgen.net/david/dev/markedjs/marked?label=devDeps)](https://david-dm.org/markedjs/marked?type=dev) [![github actions](https://github.com/markedjs/marked/workflows/Tests/badge.svg)](https://github.com/markedjs/marked/actions) [![snyk](https://snyk.io/test/npm/marked/badge.svg)](https://snyk.io/test/npm/marked) From 140aeee96f132b6504f43adf020c65678fa9d43c Mon Sep 17 00:00:00 2001 From: Tony Brix Date: Tue, 17 Nov 2020 17:28:10 -0600 Subject: [PATCH 4/7] chore(docs): add @calculuschild to authors --- docs/AUTHORS.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/AUTHORS.md b/docs/AUTHORS.md index 87ab522f98..39f2b7b5f4 100644 --- a/docs/AUTHORS.md +++ b/docs/AUTHORS.md @@ -53,7 +53,13 @@ Marked takes an encompassing approach to its community. As such, you can think o Release Wrangler; Titan of the test harness; Dr. DevOps -   + + + +
    + Trevor Buckner +
    Committer
    + Master of Marked From 4b213bb8981ebf9715c6809d0ebf6af76a81d350 Mon Sep 17 00:00:00 2001 From: Tony Brix Date: Tue, 17 Nov 2020 17:40:18 -0600 Subject: [PATCH 5/7] chore(docs): add contributors heading to authors --- docs/AUTHORS.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/AUTHORS.md b/docs/AUTHORS.md index 39f2b7b5f4..a39abe8792 100644 --- a/docs/AUTHORS.md +++ b/docs/AUTHORS.md @@ -65,6 +65,8 @@ Marked takes an encompassing approach to its community. As such, you can think o +## Contributors + From a799c4ed30ecc91ca1753905f6a96c1d92d26397 Mon Sep 17 00:00:00 2001 From: Tony Brix Date: Tue, 17 Nov 2020 17:46:01 -0600 Subject: [PATCH 6/7] chore(docs): update patch version --- docs/PUBLISHING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/PUBLISHING.md b/docs/PUBLISHING.md index 6a377e4da1..1a16beeae6 100644 --- a/docs/PUBLISHING.md +++ b/docs/PUBLISHING.md @@ -12,4 +12,4 @@ We follow [semantic versioning](https://semver.org) where the following sequence 1. **Major:** There is at least one change to the public API or a break from the [CommonMark](https://spec.commonmark.org/current/) or [GFM](https://github.github.com/gfm/) spec. 2. **Minor:** There is at least one new feature added to the public API. -3. **Patch:** No breaking changes, no new features. +3. **Patch:** Changes that move marked closer to spec compliance or change a public API that does not break backwards compatibility. From 139095b71082e2087a6127ccac782eb8c748cace Mon Sep 17 00:00:00 2001 From: Tony Brix Date: Wed, 18 Nov 2020 12:27:10 -0600 Subject: [PATCH 7/7] Update docs/PUBLISHING.md Co-authored-by: Steven --- docs/PUBLISHING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/PUBLISHING.md b/docs/PUBLISHING.md index 1a16beeae6..bf7838a168 100644 --- a/docs/PUBLISHING.md +++ b/docs/PUBLISHING.md @@ -12,4 +12,4 @@ We follow [semantic versioning](https://semver.org) where the following sequence 1. **Major:** There is at least one change to the public API or a break from the [CommonMark](https://spec.commonmark.org/current/) or [GFM](https://github.github.com/gfm/) spec. 2. **Minor:** There is at least one new feature added to the public API. -3. **Patch:** Changes that move marked closer to spec compliance or change a public API that does not break backwards compatibility. +3. **Patch:** Changes that move Marked closer to spec compliance or change a public API that does not break backwards compatibility.