Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): update versioning and other docs #1834

Merged
merged 7 commits into from
Nov 18, 2020
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ all code is your original work. `</legalese>`

## 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
Expand All @@ -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:
Expand Down
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
10 changes: 9 additions & 1 deletion docs/AUTHORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,20 @@ Marked takes an encompassing approach to its community. As such, you can think o
<small>Release Wrangler; Titan of the test harness; Dr. DevOps</small>
</td>
<td align="center" valign="top">
&nbsp;
<a href="https://github.com/calculuschild">
<img width="100" height="100" src="https://github.com/calculuschild.png?s=150">
</a>
<br>
<a href="https://github.com/calculuschild">Trevor Buckner</a>
<div>Committer</div>
<small>Master of Marked</small>
</td>
</tr>
</tbody>
</table>

## Contributors

<table>
<tbody>
<tr>
Expand Down
14 changes: 4 additions & 10 deletions docs/PUBLISHING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
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).
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.
UziTech marked this conversation as resolved.
Show resolved Hide resolved
7 changes: 6 additions & 1 deletion docs/_document.html
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,12 @@ <h1>Marked Documentation</h1>
</li>
<li><a href="/code_of_conduct">Code of Conduct</a></li>
<li><a href="/authors">Authors</a></li>
<li><a href="/publishing">Publishing</a></li>
<li>
<a href="/publishing">Publishing</a>
<ul>
<li><a href="/publishing#versioning">Versioning</a></li>
</ul>
</li>
<li><a href="/license">License</a></li>
</ul>
</nav>
Expand Down