Skip to content

Commit 9a2e9be

Browse files
committed
docs: outline release process
1 parent 3e51eec commit 9a2e9be

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,10 @@ If you want to use it with npm and have trouble, please
3333
Please, feel free to [open issues](https://github.com/funkyheatmap/funkyheatmapjs/issues) for
3434
bugs, feature requests and questions, and
3535
[submit pull requests](https://github.com/funkyheatmap/funkyheatmapjs/pulls).
36+
37+
`main` is the stable release branch. We use `dev` for development and planning future releases.
38+
Please, open feature pull requests against `dev`. We use
39+
[release-please](https://github.com/googleapis/release-please-action/) action to create a release
40+
and update the Changelog after features are merged from `dev` to `main`. We use
41+
[pr-preview-action](https://github.com/rossjrw/pr-preview-action) to preview features and docs
42+
on github pages.

0 commit comments

Comments
 (0)