Skip to content

Conversation

@sckott
Copy link
Member

@sckott sckott commented Apr 2, 2025

fix #127

the only thing from our rules table in Notion that isn't already done is perhaps the Detailed README rule, for which we have

Human review to dos:

  • README needs
    - description of what the software does
    - how to install it
    - examples of usage (OR could be in a separate vignette/article)
    - badges for automated testing outcomes, CI, etc.
    - “detailed information about who the software is intended for, how it’s intended to be used, with fully-worked examples of how to install and use the software.” 👈🏽👈🏽👈🏽
  • All exported functions/classes/etc. need documentation
  • Standalone website that contains more detailed information about the software

I think just that one line is what we maybe haven't done, which would be a good thing for the readme

@sckott sckott requested a review from seankross April 2, 2025 16:38
@sckott sckott linked an issue Apr 2, 2025 that may be closed by this pull request
2 tasks
@github-actions
Copy link

github-actions bot commented Apr 2, 2025

@sckott sckott added this to the v0.3 milestone Apr 7, 2025
@seankross
Copy link
Member

We should probably amend that detailed readme rule to say that if there's detailed documentation, then a detailed readme is not necessary.

@sckott
Copy link
Member Author

sckott commented Apr 10, 2025

thanks, will do

@sckott sckott merged commit 4d65653 into dev Apr 10, 2025
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add cran stuff

3 participants