dev_guide

dev_guide copied to clipboard

Recommend / mandate that all defaults are clearly documented

7

In many cases, the docs will read: ```r #' @param test A logical value determining if ... ``` I think it would be much better practice and clearer for the...

Bisaloo

Fix #474 Related to #478 Unsure what should really be in there.

maelle

maelle

Improve GitHub workflow guidance

2

Fix #479

maelle

Clarify/add guidance on which team member to ask for help

2

https://discuss.ropensci.org/t/staff-admin-team-codecov/2982

maelle

Update the scope for API wrappers

6

Define criteria for "something more than a thin wrapper" Cc @emilyriederer @noamross

maelle

Guidance on package archiving (Zenodo &co)

16

@noamross, you wrote "Archiving - eventually making sure all RO packages go to a scientific repository, not just JOSS packages." in https://discuss.ropensci.org/t/should-the-ropensci-dev-guide-include-package-citation-best-practices/1551/4 How should our guidance about that look like?...

maelle

Add advice on user agents?

3

Specific to packages wrapping APIs. Adding an user agent. Should that user agent be different for package developers themselves and for CI.

maelle

Git remote setup

1

- Stop recommending gitflow - Resources listed by @maurolepore [common remote setups](https://happygitwithr.com/common-remote-setups.html) and [useful Git patterns for real life](https://happygitwithr.com/workflows-intro.html)

maelle

Should the approval process take other authors more into account

6

At the moment "other authors" are invited to Slack at the same point as authors, but after approval, there's nothing automatic reg their access to the repository. Should this change?...

maelle