summaryrefslogtreecommitdiffstats
path: root/packages/markdown/marked/docs/PUBLISHING.md
diff options
context:
space:
mode:
authorLauri Ojansivu <x@xet7.org>2019-04-20 16:51:57 +0300
committerLauri Ojansivu <x@xet7.org>2019-04-20 16:51:57 +0300
commit02819ca16969b103493ebdd9a66f058995421507 (patch)
treea3352b65083c79ab733db2b99e7c4f0a1276277e /packages/markdown/marked/docs/PUBLISHING.md
parent53d42a17ffbc6466d2d422dfdcbd867ea31fe082 (diff)
parenta5122cc0764b57a163c3e8ca3e00e703669a98db (diff)
downloadwekan-02819ca16969b103493ebdd9a66f058995421507.tar.gz
wekan-02819ca16969b103493ebdd9a66f058995421507.tar.bz2
wekan-02819ca16969b103493ebdd9a66f058995421507.zip
Merge branch 'edge' into meteor-1.8
Diffstat (limited to 'packages/markdown/marked/docs/PUBLISHING.md')
-rw-r--r--packages/markdown/marked/docs/PUBLISHING.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/packages/markdown/marked/docs/PUBLISHING.md b/packages/markdown/marked/docs/PUBLISHING.md
new file mode 100644
index 00000000..27937c2f
--- /dev/null
+++ b/packages/markdown/marked/docs/PUBLISHING.md
@@ -0,0 +1,24 @@
+# Releasing Marked
+
+- [ ] See [contributing](#/CONTRIBUTING.md)
+- [ ] Create release branch from `master` (`release-x.y.z`)
+- [ ] Submit PR with minimal name: Release x.y.z
+- [ ] Complete PR checklists
+
+## Overall strategy
+
+**Master is always shippable:** We try to merge PRs in such a way that `master` is the only branch to really be concerned about *and* `master` can always be released. This allows smoother flow between new fetures, bug fixes, and so on. (Almost a continuous deployment setup, without automation.)
+
+## 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:
+
+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 analagous to a `major` release.
+3. The patch will tend to be more analagous to a `minor` release or a collection of bug fixes (patches).