forked from ropensci/dev_guide
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathappendix.Rmd
176 lines (94 loc) · 5.99 KB
/
appendix.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
# (APPENDIX) Appendix {-}
# NEWS {#booknews}
## 0.3.0
* 2019-10-03, include in the approval template that maintainers should include link to the docs.ropensci.org/pkg site (ropensci/dev_guide#191)
* 2019-09-26, add instructions for handling editors to nominate packages for blog posts (ropensci/dev_guide#180)
* 2019-09-26, add chapter on changing package maintainers (ropensci/dev_guide#128) (ropensci/dev_guide#194)
* 2019-09-26, update Slack room to use for editors (ropensci/dev_guide#193)
* 2019-09-11, update instructions in README for rendering the book locally (ropensci/dev_guide#192)
* 2019-08-05, update JOSS submission instructions (ropensci/dev_guide#187)
* 2019-07-22, break "reproducibility" category in policies into component parts. (ropensci/software-review-meta#81)
* 2019-06-18, add link to rOpenSci community call "Security for R" to security chapter.
* 2019-06-17, fix formatting of Appendices B-D in the pdf version of the book (bug report by [`@IndrajeetPatil`](https://github.com/IndrajeetPatil), #179)
* 2019-06-17, add suggestion to use R Markdown hunks approach when the README and the vignette share content. (ropensci/dev_guide#161)
* 2019-06-17, add mention of central building of documentation websites.
* 2019-06-13, add explanations of CRAN checks. (ropensci/dev_guide#177)
* 2019-06-13, add mentions of the `rodev` helper functions where relevant.
* 2019-06-13, add recommendation about using `cat` for `str.*()` methods. RStudio assumes that `str` uses `cat`, if not when loading an R object the `str` prints to the console in RStudio and doesn't show the correct object structure in the properties. ([`@mattfidler`] (https://github.com/mattfidler/) #178)
* 2019-06-12, add more details about git flow.
* 2019-06-12, remove recommendation about `roxygen2` dev version since the latest stable version has what is needed. ([`@bisaloo`](https://github.com/bisaloo/), #165)
* 2019-06-11, add mention of usethis functions for adding testing or vignette infrastructure in the part about dependencies in the package building guide.
* 2019-06-10, use the new URL for the dev guide, https://devguide.ropensci.org/
* 2019-05-27, add more info about the importance of the repo being recognized as a R package by linguist ([`@bisaloo`](https://github.com/bisaloo/), #172)
* 2019-05-22, update all links eligible to HTTPS and update links to the latest versions of Hadley Wickham and Jenny Bryan's books ([`@bisaloo`](https://github.com/bisaloo/), #167)
* 2019-05-15, add book release guidance for editors. (ropensci/dev_guide#152)
## 0.2.0
* 2019-05-23, add CRAN gotcha: in the Description field of your DESCRIPTION file, enclose URLs in angle brackets.
* 2019-05-13, add more content to the chapter about contributing.
* 2019-05-13, add more precise instructions about blog posts to approval template for editors.
* 2019-05-13, add policies allowing using either `<-` or `=` within a package as long as the whole package is consistent.
* 2019-05-13, add request for people to tell us if they use our standards/checklists when reviewing software elsewhere.
* 2019-04-29, add requirement and advice on testing packages using `devel` and `oldrel` R versions on Travis.
* 2019-04-23, add a sentence about why being generous with attributions and more info about ctb vs aut.
* 2019-04-23, add link to Daniel Nüst's notes about migration from XML to xml2.
* 2019-04-22, add use of rOpenSci forum to maintenance section.
* 2019-04-22, ask reviewer for consent to be added to DESCRIPTION in review template.
* 2019-04-22, use a darker blue for links (feedback by [`@kwstat
`](https://github.com/kwstat), #138).
* 2019-04-22, add book cover.
* 2019-04-08, improve formatting and link text in README ([`@katrinleinweber`](https://github.com/katrinleinweber), #137)
* 2019-03-25, add favicon ([`@wlandau`](https://github.com/wlandau), #136).
* 2019-03-21, improve Travis CI guidance, including link to examples. ([`@mpadge`](https://github.com/mpadge), #135)
* 2019-02-07, simplify code examples in Package Evolution section (maintenance_evolution.Rmd file) ([`@hadley`](https://github.com/hadley), #129).
* 2019-02-07, added a PDF file to export (request by [`@IndrajeetPatil`](https://github.com/IndrajeetPatil), #131).
## 0.1.5
* 2019-02-01, created a .zenodo.json to explicitly set editors as authors.
## First release 0.1.0
* 2019-01-23, add details about requirements for packages running on all major platforms and added new section to package categories.
* 2019-01-22, add details to the guide for authors about the development stage at which to submit a package.
* 2018-12-21, inclusion of an explicit policy for conflict of interest (for reviewers and editors).
* 2018-12-18, added more guidance for editor on how to look for reviewers.
* 2018-12-04, onboarding was renamed Software Peer Review.
## place-holder 0.0.1
* Added a `NEWS.md` file to track changes to the book.
# Review template {#reviewtemplate}
```
```{r eval = !knitr::is_latex_output(), child="templates/review.md"}
```
```
```{r eval = knitr::is_latex_output(), child="templates/review.md"}
```
# Editor's template {#editortemplate}
```
```{r eval = !knitr::is_latex_output(), child="templates/editor.md"}
```
```
```{r eval = knitr::is_latex_output(), child="templates/editor.md"}
```
# Review request template {#reviewrequesttemplate}
Editors may make use of the e-mail template below in recruiting reviewers.
```
```{r eval = !knitr::is_latex_output(), child="templates/request.md"}
```
```
```{r eval = knitr::is_latex_output(), child="templates/request.md"}
```
# Approval comment template {#approvaltemplate}
```
```{r eval = !knitr::is_latex_output(), child="templates/approved.md"}
```
```
```{r eval = knitr::is_latex_output(), child="templates/approved.md"}
```
# NEWS template {#newstemplate}
```
```{r child="templates/news.md"}
```
```
# Book release guidance {#bookreleaseissue}
```
```{r eval = !knitr::is_latex_output(), child="templates/book-release.md"}
```
```
```{r eval = knitr::is_latex_output(), child="templates/book-release.md"}
```