Skip to content

Commit

Permalink
More info on sharing (rweekly#703)
Browse files Browse the repository at this point in the history
  • Loading branch information
maelle authored May 16, 2020
1 parent c1f1b45 commit 01d3d53
Show file tree
Hide file tree
Showing 3 changed files with 63 additions and 15 deletions.
73 changes: 58 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,41 +4,84 @@

R weekly provides weekly updates from the R community. You are welcome to contribute as long as you follow [our code of conduct](CODE_OF_CONDUCT.md) and [our contributing guide](CONTRIBUTING.md).

## How to contribute by using this repo
## How to have (my) content shared by R Weekly?

Update the [draft](https://github.com/rweekly/rweekly.org/blob/gh-pages/draft.md) post, and create a pull request.
We're all about spreading content about R, be it blog posts, tutorials, screencasts, slidedecks, etc.
Please help us!

Please respect the categories indicated in the [contributing guide](CONTRIBUTING.md). The contributing guide also explains how to add images if necessary and when the weekly newsletter is frozen.
**In general for feeds and one time sharing we prefer https over http.**

## How to contribute without using Github
### Regular R posts: submit your RSS feed

Submit your links or feeds for R Weekly posts and podcasts via going to [https://rweekly.org/submit](https://rweekly.org/submit).
Submit your blog RSS feed via [https://rweekly.org/submit](https://rweekly.org/submit).
If your blog doesn't have an RSS feed yet, look up for resources / help for doing it, it's worth it!

Note: Please💡 Use [W3C Feed Validation](https://validator.w3.org/feed/) Service to checks the syntax of Atom or RSS feeds.
What rules are there?

* The RSS feed has to be mainly related to R, so if your content mixes R and baking posts please create a specific R feed. Now, if there's one off topic post once in a while, it's fine, we'll remove it from the release.

* Please💡 Use [W3C Feed Validation](https://validator.w3.org/feed/) Service to checks the syntax of Atom or RSS feeds.

* We don't need a full content RSS feed since we'll only use links and titles.

### One off sharing

**What?**

An URL to a **free** resource about R, or using R.
If it's a book, we won't advertise it unless there's a free online version.
In posts/tutorials, the R code has to be visible or easy to find.
We check for duplicates over the last issues.

**How?**

* Via this very GitHub repo. Update the [draft](https://github.com/rweekly/rweekly.org/blob/gh-pages/draft.md) post, and create a pull request. Please respect the categories indicated in the [contributing guide](CONTRIBUTING.md) but don't worry, we can reshuffle content as needed. You can suggest an image in the comment of the PR but don't add images to your PR edits, the editor in charge of the release will pick images.

We prefer PRs because they're more transparent and make the workflow smoother for us (merging a PR vs copy-pasting from the form output) but if you're afraid of GitHub use the form... or open a PR anyway, we'll teach you!

**[Contribute to R-Weekly via Pull Requests: short screencast created by Sina Rüeger demonstrating how you can contribute a new link to the R-Weekly issue via a GitHub pull request](https://www.youtube.com/watch?v=oNcW5xeV1bw)**

* Submit your links or feeds for R Weekly posts and podcasts via going to [https://rweekly.org/submit](https://rweekly.org/submit).


**When?**

It's best to submit links between Monday and Friday, because we pick links for our highlights poll on Fridays. :wink:
The issue is frozen on Sundays.
No time is indicated because it depends on the timezone & time availabilities of the volunteer editor in charge of the release.

## Where does the content come from?

For nitty-gritty details see [the process release editors follow](https://github.com/rweekly/rweekly.org/wiki/Release-Editor-FAQ).

* From RSS feeds

* From links contributed by the community via PRs or [https://rweekly.org/submit](https://rweekly.org/submit).

* From editors', in particular the editor in charge of the release that week, looking over their own Twitter likes, feed readers etc. But really, if you can and are aware of R Weekly, it's better to proactively submit your content (or content by someone else and that you found great!) rather than to hope we'll have seen it. We miss cool stuff all the time despite our best efforts!

## Communication

### Talk with us!

Have a question or great idea about this website?
Have a question or great idea about this website?

Talk with us on [Twitter](https://twitter.com/rweekly_org) or [Google Groups](https://groups.google.com/forum/#!forum/rweekly) or [via opening an issue](https://github.com/rweekly/rweekly.org/issues/new).
Talk with us on [Twitter](https://twitter.com/rweekly_org) or [an GitHub issue](https://github.com/rweekly/rweekly.org/issues/new).

### Join us!

Are you passionate about sharing content from the R community? After creating at least 10 pull requests, fill [this form](https://docs.google.com/forms/d/1WdCjXvWJ1tDSlZNJAroGWCWcqqDjRMAF2VNnZCfn14g/viewform) to join our team!
Are you passionate about sharing content from the R community? After creating at least 10 pull requests, fill [https://docs.google.com/forms/d/e/1FAIpQLSet2Tq_mWWOVsKWxGOSoUg8DzCPlW2-nxIFOSkkRvlUFxQFLw/viewform) to join our team!

Each weekly contains at most 3 highlight posts. When there are special events, eg. UseR!, we can have more highlight posts. Members of the R Weekly will vote for at most three posts on the R Weekly Slack channel every Saturday. If you do not want to recommend any post, you can skip the vote. There is a handy shiny widget rweekly/rweekly-highlights to generate poll for Slack.
Responsabilities of editors

A member will receive a notice about his/her inactive status for two months in the organization. A member will leave R Weekly organization if the inactive status passes 75 days.
* [Handle a release every few weeks](https://github.com/rweekly/rweekly.org/wiki/Release-Editor-FAQ). We agree on the schedule and swap weeks as needed.

### Some admin details
* Vote on the highlight on Saturdays, which can be skipped when you have no time or no opinion. Each release contains at most 3 highlight posts in general. Editors will vote for at most three posts on the R Weekly Slack channel every Saturday. If you do not want to recommend any post, you can skip the vote.

GitLab: https://gitlab.com/groups/rweekly
A member will receive a notice about his/her inactive status for two months in the organization. A member will leave R Weekly organization if the inactive status passes 75 days.

Admin: https://rssadmin.rweekly.org
## Support with Patreon

rweekly-highlights: https://github.com/rweekly/rweekly-highlights
[Donate to R Weekly with Patreon](https://www.patreon.com/rweekly)

Thanks for reading!
2 changes: 2 additions & 0 deletions draft.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ Release Date: 2020-05-18

This week’s release was curated by [Maëlle Salmon](https://twitter.com/ma_salmon), with help from the R Weekly team members and contributors.

+ [How to have (my) content shared by R Weekly?](https://github.com/rweekly/rweekly.org/tree/master#how-to-have-my-content-shared-by-r-weekly)

### Highlight


Expand Down
3 changes: 3 additions & 0 deletions for-editor-only-draft.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ image: https://rweekly.org/public/facebook.png

Release Date: 2020-00-00

+ [How to have (my) content shared by R Weekly?](https://github.com/rweekly/rweekly.org/tree/master#how-to-have-my-content-shared-by-r-weekly)


### Highlight


Expand Down

0 comments on commit 01d3d53

Please sign in to comment.