rOpenSci Blog Guidelines for Authors and Editors
Preface
I Author Guide
1
Content Guidelines
1.1
Blog post or tech note?
1.2
Themes of posts
1.3
What goes in your post?
1.3.1
What message would you like a reader to take away?
1.3.2
Who is your audience?
1.3.3
Start with a short summary
1.3.4
Give a compelling example
1.3.5
Be generous with your appreciation
1.3.6
Consider including a call to action
1.3.7
Conclusion or summary
1.3.8
We love these posts about packages
2
Technical Guidelines
2.1
Fork the repo and create your post folder
2.2
Start the post from a template
2.2.1
Get Markdown template
2.2.2
Get R Markdown template
2.2.3
Get any template from the roblog package
2.3
Walkthrough with code snippets
2.3.1
What goes in YAML
2.3.2
Add tags
2.3.3
Examples
2.3.4
To add an image
2.3.5
To add a citation
2.3.5.1
How to find citation text for a package or article
2.3.6
To add a tweet
2.3.7
Don’t use html widgets
2.4
Style guide
2.5
Create or update your author file
2.5.1
Why?
2.5.2
How?
2.5.3
Examples
2.6
Pre-submission checks
2.6.1
Checklist for a post about a peer-reviewed package
2.6.2
Checklist for any other post
2.7
Submit your draft post
2.7.1
Local preview with Hugo
2.7.2
Make a pull request
3
Responding to Editor’s review
3.1
Where to look for comments and suggested commits
3.2
How to edit and signal to editor you have addressed all comments
4
Publication and Promotion
II Editor Guide
5
Review, Publish, Promote
5.1
Review a Post
5.1.1
Review
5.1.2
Checklist for a post about a peer-reviewed package
5.1.3
Checklist for any other post
5.1.4
Note about non automatic tech checks
5.1.5
Check Twitter metadata
5.2
Publish a Post
5.3
Promote a Post on Twitter
5.3.1
Workflow
5.3.2
Content
5.3.3
Tagging accounts
5.3.4
Using hashtags
5.3.4.1
Selecting relevant hashtags
5.3.4.2
Adding hashtags
5.3.5
Using emojis
5.3.6
Using gifs
5.3.7
Example 2-tweet thread:
Appendix
A
Post template in Markdown
B
Post template in R Markdown
C
Author file template
D
Author checklist for a post about a peer-reviewed package
E
Author checklist for any other post
F
Editor checklist for a post about a peer-reviewed package
G
Editor checklist for any other post
Published with bookdown
rOpenSci Blog Guidelines for Authors and Editors
Chapter 3
Responding to Editor’s review
these are placeholder headings
3.1
Where to look for comments and suggested commits
3.2
How to edit and signal to editor you have addressed all comments