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

Add contributing notes #19

Open
fkohrt opened this issue Sep 18, 2024 · 0 comments
Open

Add contributing notes #19

fkohrt opened this issue Sep 18, 2024 · 0 comments

Comments

@fkohrt
Copy link
Contributor

fkohrt commented Sep 18, 2024

There are some things to consider when contributing to this repo:

  • make screenshots in high resolution by temporarily increasing the font scaling factor in your OS and using a large display
  • limit the width of images
  • annotate code blocks with filename="Terminal" andfilename="Console" to differentiate Bash and R (if there is no file from which the code is an excerpt)
  • Put optional content into a collapsed note
  • Put important content into warning
  • hierarchy of callouts
    • note
    • tip
    • caution
    • warning
    • important
  • headings are written in title case
  • headings are only H2 and below because the title is already H1
  • callouts use context-specific heading levels that are one below the current heading level
  • R package names are typeset in monospace
  • Prefer R packages that follow the tinyverse philosophy, that is, have a lightweight dependency footprint. All packages need to be downloaded by renv and (worst case) compiled during the tutorial, which better not take too long. Use pak::pkg_deps() to count the total number of package dependencies.

Let's create a CONTRIBUTING.md file that mentions these points.

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

No branches or pull requests

1 participant