fledge icon indicating copy to clipboard operation
fledge copied to clipboard

is there a cynkra-wide code of conduct?

Open maelle opened this issue 4 years ago • 9 comments

maelle avatar Oct 01 '21 08:10 maelle

Not yet, I tend to use the standard CoC from usethis (but the wording of v2 was a bit odd last time I checked).

krlmlr avatar Oct 01 '21 19:10 krlmlr

Then maybe use v1/rephrase? The result could be stored in github.com/cynkra/.github

maelle avatar Oct 04 '21 11:10 maelle

Will it be caught by pkgdown when it sits there?

krlmlr avatar Oct 11 '21 07:10 krlmlr

In the meantime we could add it locally, I do prefer an org-wide solution though.

krlmlr avatar Oct 11 '21 07:10 krlmlr

Will it be caught by pkgdown when it sits there?

No https://github.com/r-lib/pkgdown/issues/1802 but in that same issue I mentioned two workarounds.

maelle avatar Oct 11 '21 07:10 maelle

A custom sidebar feels unstable because we'd need to adapt when pkgdown changes. Can we include code that copies from the org-wide repo in the GHA workflow? Can you share an example for a repo with an org-wide CoC?

krlmlr avatar Oct 11 '21 07:10 krlmlr

I do not have an example but I do not think it'd be too hard to query the GitHub API and copy files.

What I mean by custom sidebar is not a custom template though, is adding a few lines to the configuration files, and configuration files can be shared via a pkgdown template package. https://github.com/r-lib/pkgdown/pull/1565/files I could show that after there is a pkgdown preview workflow, it might be an easier solution although it will make the COC link location a bit different I suppose. Now with this an issue is whether to link to the COC Markdown or to a rendered version "somewhere" (might be cynkra website for instance).

maelle avatar Oct 11 '21 08:10 maelle

I was curious to see a repo in an org that has an org-wide CoC -- is it mentioned in the GitHub sidebar? It isn't shown in https://github.com/cynkra/dm/, but maybe because it's not in .github/ ?

You can create a branch with docs-* as a name, it will be pushed to dev pkgdown.

krlmlr avatar Oct 11 '21 08:10 krlmlr

Ah then look at https://github.com/ropensci/magick, the COC shows up e.g. when opening an issue.

maelle avatar Oct 11 '21 08:10 maelle