h2oai / h2o-3

H2O is an Open Source, Distributed, Fast & Scalable Machine Learning Platform: Deep Learning, Gradient Boosting (GBM) & XGBoost, Random Forest, Generalized Linear Modeling (GLM with Elastic Net), K-Means, PCA, Generalized Additive Models (GAM), RuleFit, Support Vector Machine (SVM), Stacked Ensembles, Automatic Machine Learning (AutoML), etc.
http://h2o.ai
Apache License 2.0
6.94k stars 2k forks source link

Add a NEWS file to the h2o R package #9480

Open exalate-issue-sync[bot] opened 1 year ago

exalate-issue-sync[bot] commented 1 year ago

We should add a NEWS.md file to the R package that summarizes all new R-related changes for each stable release. Most R packages have a NEWS file, which is the standard place to announce changes between versions. Right now we have a "fake news" ;-) file: https://cran.r-project.org/web/packages/h2o/NEWS

Why don't we just copy over the Changes.md file as the NEWS.html file (which would include HTML) and add it under "Materials" like [data.table| https://cran.r-project.org/web/packages/data.table/] does: https://cran.r-project.org/web/packages/data.table/news.html

exalate-issue-sync[bot] commented 1 year ago

Erin LeDell commented: I added the NEWS file to the R package, but right now it's just a template. For the next release (after Tibshirani) and from now on, we will include all the R changes here.

exalate-issue-sync[bot] commented 1 year ago

Bill Gallmeister commented: Erin, is this ticket still applicable? I'm going through tickets labelled "in progress" but for which there's been no update in 6 months or more...

exalate-issue-sync[bot] commented 1 year ago

Jan Gorecki commented: We have Changes.md in h2o-3, it could be used to produce R NEWS on per-release basis. Otherwise we may get into annoying merges between unrelated PRs, where each PR write own entry in NEWS file and merges are not fast-forward anymore. From maintenance point of view it also make sense to document changes in single place, then (partially) re-use in another. We could add [r] or [py] tags in Changes.md. Let me know what you think about it. [~accountid:557058:afd6e9a4-1891-4845-98ea-b5d34a2bc42c]

exalate-issue-sync[bot] commented 1 year ago

Erin LeDell commented: [~accountid:557058:89297402-cb5a-4710-9511-20f42b25451a] Why did you close this? I added a template NEWS file, but there's nothing in it, so this is not complete. The goal was to fill this out automatically from Changes.md or tickets marked as "R".

exalate-issue-sync[bot] commented 1 year ago

Navdeep commented: [~accountid:557058:afd6e9a4-1891-4845-98ea-b5d34a2bc42c] Sorry, read this as an rsparkling issue. Pulled the trigger too soon.

exalate-issue-sync[bot] commented 1 year ago

Erin LeDell commented: This was closed by mistake; re-opening.

h2o-ops commented 1 year ago

JIRA Issue Migration Info

Jira Issue: PUBDEV-2537 Assignee: Navdeep Reporter: Erin LeDell State: Reopened Fix Version: N/A Attachments: N/A Development PRs: N/A