Preface

The purpose of this documentation is to provide a guide for authors and editors of blog posts and tech notes for the rOpenSci website. We created it after reviewing and publishing over 100 posts by community members, in hopes of addressing many frequently asked questions, and frequently given suggestions.

The volume of information may be overwhelming at first. Some of the guidance indicates things we require that you do (such as creating an author file with your metadata), while most of the guidance is information to help you (such as how to add an image to your post).

What’s in the book and what’s required reading?

  • Chapter 1 Content Guidelines coaches you in thinking through what you might say in your post.

  • Chapter 2 Technical Guidelines is required reading for submitting a post - from drafting in an (R) Markdown template to submitting for review using GitHub pull request infrastructure.

  • Chapter 3 Responding to Editor’s Review is required reading, briefly outlining how to find and respond to an editor’s comments in the GitHub pull request review interface.

  • Chapter 4 Publication and Promotion provides some motivation for doing the extra work to contribute a post by outlining what rOpenSci does to promote it.

  • Chapters 5 and 6 provide guidelines for editors reviewing, publishing and promoting posts and outine editorial governance.

If you find any errors or things that need clarification, we would be grateful if you opened an issue or pull request in the repository for this book.

We are thankful for the feedback and contributions from Hugo Gruson and Mark Padgham.