Skip to content
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

[Question]: Did we miss package related activities during pre-release? #1071

Closed
m7pr opened this issue Feb 19, 2024 · 0 comments · Fixed by #1072
Closed

[Question]: Did we miss package related activities during pre-release? #1071

m7pr opened this issue Feb 19, 2024 · 0 comments · Fixed by #1072
Assignees
Labels
core question Further information is requested

Comments

@m7pr
Copy link
Contributor

m7pr commented Feb 19, 2024

In my opinion this issue #1014 and this one #919 (comment)
did not cover the regular list of package pre-release activities that we normally have for each package. Check the list that we had for teal.transform insightsengineering/teal.transform#176
For example:

All package names in Title and Description fields of DESCRIPTION file are quoted with ' (not backtick)

Make sure all teal.* mentions are lower-cased and quoted

are not included.

This made me think we should just go over again this list

@m7pr m7pr added the question Further information is requested label Feb 19, 2024
@m7pr m7pr self-assigned this Feb 19, 2024
@m7pr m7pr added the core label Feb 19, 2024
@m7pr m7pr mentioned this issue Feb 19, 2024
9 tasks
shajoezhu pushed a commit that referenced this issue Feb 20, 2024
Close #1071 

This PR was meant to update README and DESCRIPTION file up to standards
we had for other teal packages before the release. Some of the
DESCRIPTION changes are CRAN requirements.

### Summary

* [x] Review and update README.md
    * [x] add CRAN badges to README
    * [x] add Getting Help section to README
    * [x] change installation guidelines to use CRAN
    * [x] cleanup usage section
* [x] Package `Title` is not duplicated in Package `Description` in
DESCRIPTION file
* [x] Make sure all `teal.*` mentions are lower-cased and quoted
* [x] Make sure each link to our documentation hosted with pkgdown on
github pages do not have `/main/` in the address
  * it should have has `/latest-tag/` instead
* so we always expose the documentation of the latest release and not
what's currently on main branch but not yet released
* [x] All package names in `Title` and `Description` fields of
DESCRIPTION file are quoted with `'` _(not backtick)_
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core question Further information is requested
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant