WIP: Update top ten tips

[tobyhodges]

This updates the Top Ten Tips list, based on changes made by @ndporter and me in a recent coworking call. It should be merged after the new sections have been added to the Maintainer handbook, about when to merge your own PRs and what to do when you don't get a response from other Maintainers. When that has been added to the handbook, we can add a link here and merge.

[github-actions]

Thank you!

Thank you for your pull request 😃

🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

• 🎯 correct output
• 🖼️ correct figures
• ❓ new warnings
• ‼️ new errors

Rendered Changes

🔍 Inspect the changes: https://github.com/carpentries/maintainer-onboarding/compare/md-outputs..md-outputs-PR-113

The following changes were observed in the rendered markdown documents:

 02-communicate-contributors.md | 25 +++++++++++--------------
 md5sum.txt                     |  2 +-
 2 files changed, 12 insertions(+), 15 deletions(-)

What does this mean?

If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible.

This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

⏱️ Updated at 2024-12-02 19:05:35 +0000