Skip to content

Improve changelog format, internal developer documentation #233

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

Open
5 tasks
brookslogan opened this issue Oct 21, 2022 · 1 comment
Open
5 tasks

Improve changelog format, internal developer documentation #233

brookslogan opened this issue Oct 21, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation P3 very low priority

Comments

@brookslogan
Copy link
Contributor

brookslogan commented Oct 21, 2022

Taken from discussion on #222.

  • Consider regrouping entries: comment 1, comment 2. Or consider tidyverse news style.
  • "Here and elsewhere: try to limit to a small number of verbs. Maybe a recommended verb set, although some of these are trying to accomplish what the categories already do, but we might move from categories -> "importance", and then these would still be useful even though they might look redundant now."
  • Look at decision/comments in Add changelog (NEWS.md), associated pkgdown styling #222 on adding a dev branch and what the default branch should be, and implement them.
  • Add an (epiproess) developer doc describing the branching and version release procedure.
  • Turn the retrospective version branches into release version tags.
@brookslogan brookslogan added documentation Improvements or additions to documentation P3 very low priority labels Oct 21, 2022
@dshemetov
Copy link
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation P3 very low priority
Projects
None yet
Development

No branches or pull requests

2 participants