ropensci-org / contributing-guidance Goto Github PK

add https://ropensci.org/usecases/ to https://contributing.ropensci.org/resources.html#usecases

add to welcome?

Please cite this guide as (figure out how we want it)

rOpenSci Community Contributing Guide https://contributing.ropensci.org/
Stefanie Butland and Steffi LaZerte
doi

We def want to monitor traffic to the Guide.
Maëlle is assessing which analytics tool to use ropensci-org/blog-guidance#122

since Scott no longer here
https://contributing.ropensci.org/intro.html

• Read rOpenSci & Our Community learn about our mission

  • add "to"

• bold The rOpenSci community is a self-identifying group in https://contributing.ropensci.org/intro.html#community

• in https://contributing.ropensci.org/intro.html#humans

  • undo some bold in Over 150 people have reviewed 135 packages from 803 authors!
  • link to Nick T https://ropensci.org/author/nicholas-tierney/ and Saskia https://twitter.com/trashystats

• in https://contributing.ropensci.org/motivations.html

  • motivations, which can include -> that can include?

• in https://contributing.ropensci.org/motivations.html#build

  • is this action link appropriate? Promote software citations - Cite rOpenSci packages in manuscripts and presentations. Or do we make it one action with Ensure your package is easily citable. Cite rOpenSci packages in manuscripts and presentations and encourage your colleagues to do the same

• in https://contributing.ropensci.org/motivations.html#help

  • The ways you can help rOpenSci and our community are limitless -> The ways you can help are limitless

• in table https://contributing.ropensci.org/resources.html#channels

  • A semi-closed space -> semi-open

• https://contributing.ropensci.org/resources.html#channels

  • Public discussion forum - take link out of heading and move it to "The forum" in text to make consistent look with other headings

• in https://contributing.ropensci.org/resources.html#channels-slack

  • link "We actively welcome new members" to https://ropensci.org/blog/2017/07/18/value-of-welcome/

• in https://contributing.ropensci.org/resources.html#packages
  "To do so, take a look at the project’s contributing guide," -> To do so, take a look at the project’s contributing guide (here's a nice CONTRIBUTING.md example from Peter Desmet)

We can improve the look

from Maëlle:

not for your MVP but you might want to have special formatting for things like that see https://bookdown.org/yihui/bookdown/custom-blocks.html

Karthik suggested using some callouts to break up text

e.g. https://contributing.ropensci.org/resources.html#packages

In https://contributing.ropensci.org/intro.html#humans

Replace the team screenshot with a new one from https://roweb3-hugo.netlify.app/about/
Include all staff down to editors. Do not include any "Our Team" text in the screenshot

replace old link https://ropensci.org/onboarding/ with https://airtable.com/shrnfDI2S9uuyxtDw

It's linked from "Fill out this form to get started" https://contributing.ropensci.org/resources.html?q=review#devguide

Does this mean https://ropensci.org/onboarding/ should have forwarding set up in roweb3? If yes, could you please open an issue?

https://contributing.ropensci.org/bibiliography.html

as in dev guide https://devguide.ropensci.org/newstemplate.html

https://discuss.ropensci.org/c/wishlist/6

maybe use the one from roweb3

I think I prefer a collage like the one in the gdoc from Mara

Noam's comment to consider & paraphrase where appropriate

we want people to build/review/submit packages, write tutorials and support community members in ways that that support open, reproducible science and this is somewhat different than doing these things generically or improving the R ecosystem. The broad way of puttinng it might be doing things that "solve problems for research, especially problems that aren't being solved by companies or general data science." We could be more specific, too, and say these things should have a focus on: Expanding access to scientific resources, enabling FAIR practices by scientists, supporting principles of transparency and collaboration, enabling fully open-source scientific workflows.

In table of communication channels https://contributing.ropensci.org/resources.html#channels

Makes diffs easier to interpret and easier for editor to suggest specific changes.

(we recommend this in blog guide - style guide already)

https://contributing.ropensci.org/intro.html#humans

I felt like we needed a "why review" section. Something about uniqueness of the system. And benefits to participation. Was at a loss so I copied txt from dev guide

Noam suggested deleting this so we did ("This seems out of place? It's a useful piece of info but I'm not sure why it's the one that is pulled out of the guide and put first. I was going to move it down, but I actually now think it should be removed; it doesn't follow the flow of the section.")

Why are reviews open? Our reviewing threads are public. Authors, reviewers, and editors all know each other’s identities. The broader community can view or even participate in the conversation as it happens. This provides an incentive to be thorough and provide non-adversarial, constructive reviews. Both authors and reviewers report that they enjoy and learn more from this open and direct exchange. It also has the benefit of building a community. Participants have the opportunity to meaningfully network with new peers, and new collaborations have emerged via ideas spawned during the review process.

png and pdf of cover from Karthik are here: https://github.com/ropensci-org/contributing-guidance/tree/master/images

Add some text in the welcome/intro that the illustration was done by Lydia like "Cover illustration by Lydia Hill"

Zenodo Jan 20, 2021

Matomo?

Until we have a tech note or a dev guide section with recommendations, keep it simple with not too many references to this

Using Maëlle's code at https://github.com/rosadmin/blogauthors#blogauthors fill in n in

Blog {#blog}

We’ve published more than n posts since 2012.

https://contributing.ropensci.org/intro.html#humans

Over 150 people have reviewed packages by XX package authors. XX people have made code and non-code contributions (measured as GitHub commits in ropensci & ropenscilabs orgs).

"Address an issue. Explore open issues in rOpenSci packages and consider submitting a fix." lives only in Connect https://contributing.ropensci.org/motivations.html#build but addressing an issue = Build too

:-)

https://contributing.ropensci.org/resources.html#channels-github

"3.2.0.1 GitHub"

Should be bold, but with less spacing below and look more like normal, body text. Also no numbers before it.

bookdown make it possible to create a .pdf version of the website. May be it make sense to make it available for downloading since some people prefer read offline.

On https://blogguide.ropensci.org/ front page, clicking on twitter icon leads to opening twitter with link to the guide

@maelle can you please point to the file in https://github.com/ropensci-org/blog-guidance where this is enabled so we can do this in https://github.com/ropensci-org/contributing-guidance?

I think if the expandable link was formatted like a link (bold and blue), it might be easier for users to realized that they can click on it. Even when I read the text in the Blog Guide, I half didn't believe it :)

"It’s the journey, not the destination. quote attribution"

MVP or remove the quote?

"Read about our community, and some of the communities built by our members. See examples from the Australian “ozunconfs”, rOpenSci Antarctic and Southern Ocean Research, LatAm rOpenSci community, CDSB."

This is new - didn't happen before

solution? https://twitter.com/dgkeyes/status/1320823516141285376

Review all sections, reduce redundancy by finding best-fit actions. e.g. Build should reflect more technical contributions, so can remove some things

Title says it all. MVP because of disabilities?

In https://contributing.ropensci.org/resources.html#issues there's "You can also combine labels in a search.". Should there be an example and/or a link to GitHub advanced search?

It's doesn't go back and should

Right now the edit button works, but links to https://github.com/ropensci-org/contributing-guidance/edit/master/intro.Rmd because we use sub docs. This isn't super helpful...

{#Learn}
{#Discover}
wording of {#channels} e.g. Slack

Add guide and blog guide to bookdown books list via PR (I forget where this is. Yihui manages it I think)

Comment from @maelle

I'd like to see a few tips on how to "follow" the forum.

• open the website once in a while.
• subscribe via the forum, then in your mailing thing make it come to a special inbox, read it once in a while.
• I don't think there's an RSS feed integration but worth asking Scott (it'd fit in some people's workflows)
• in Slack there's a channel reposting all messages.