From a1aba206c49e1cacd8ee1ca18a3392f7b873e707 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89tienne=20T=C3=A9treault-Pinard?= Date: Thu, 24 Aug 2023 16:21:44 -0400 Subject: [PATCH 1/3] add a few more details to the release checklist --- CONTRIBUTING.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b4438df..b74219d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -76,7 +76,7 @@ releasing. ### step 1 Make sure the [unit tests][jltest] and [CircleCI integration tests][circlecI] -are passing. +are passing off the `dev` branch. ### step 2 @@ -89,7 +89,10 @@ For consistency, name the PR: "Release X.Y.Z" Bump the `version` field in the `Project.toml` (following [semver][semver]) and then ```sh +git checkout dev +git pull origin dev git commit -m "X.Y.Z" +git push ``` **N.B.** use `X.Y.Z` not `vX.Y.Z` in the commit message, the leading `v` is @@ -131,8 +134,8 @@ git push --tags Go the [release page][releases] and create a new release, name it "Version X.Y.Z" for consistency and fill out sections: -- _What's Changed_, which should include items for all the PRs merged since the last release -- _New Contributor_, which should include mention of all the first-time contributors +- (usually) _Added_, _Changed_, _Fixed_ while including links to the PRs merged since the last release +- _New Contributor_, which should include mentions for all the first-time contributors finally, place a [GitHub compare link][compare] between the last release and X.Y.Z e.g. this [one][ex-diff]. From dec22f6b3c3cf79008d5ebe007181824b1e5523e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89tienne=20T=C3=A9treault-Pinard?= Date: Thu, 24 Aug 2023 16:21:49 -0400 Subject: [PATCH 2/3] add useful links --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index cca6e4c..050920b 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,11 @@ Built on top of Plotly.js, React and HTTP.jl, [Dash](https://plotly.com/dash/) t Just getting started? Check out the [Dash for Julia User Guide](https://dash.plotly.com/julia)! If you can't find documentation there, then check out the unofficial [contributed examples](https://github.com/plotly/Dash.jl/issues/50) or check out source code from [demo applications](https://dash.gallery) in Python and then reference the Julia syntax style. +## Other resources + +- +- + ## Project Status Julia components can be generated in tandem with Python and R components. Interested in getting involved with the project? Sponsorship is a great way to accelerate the progress of open source projects like this one; please feel free to [reach out to us](https://plotly.com/consulting-and-oem/)! From 989269171c63adbcb1192dbaddc09a6ea28c7793 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89tienne=20T=C3=A9treault-Pinard?= Date: Thu, 24 Aug 2023 16:39:59 -0400 Subject: [PATCH 3/3] fixup markdown items --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 050920b..622e316 100644 --- a/README.md +++ b/README.md @@ -13,8 +13,8 @@ Just getting started? Check out the [Dash for Julia User Guide](https://dash.plo ## Other resources -- -- +* +* ## Project Status