marcosvital / teach-R-project

Sharing knowledge and material for teaching R courses!
GNU General Public License v3.0
37 stars 18 forks source link

Contributors guidelines for the sprint #7

Open marcosvital opened 7 years ago

marcosvital commented 7 years ago

Hi, everyone, and thanks again for everyone willing to contribute with this project. You are all awesome! :D

We have a general purpose contributing file in the project here, but it will be better if we work with specific tasks and guidelines during the sprint, and that's why I'm opening this issue.

How can you help

R courseware direct contributions

If you have any sort of courseware, you can just add it directly to the project. You can consider adding from complete courses (with slides, scripts, data, guides and everything related) to more specific material such as tutorials that could be used for anyone that would like to teach an R course.

Right now the repo has a courses folder here to hold this. It's broken down in english and portuguese folders, since I expect to have material in both languages (but we can surely expand to include more languages). You can add your course/tutorial in a new folder inside the correspondent language. The main possibilities are:

I'll submit this now, and will expand it with more contributors possibilities below. ;)

Project website!

Argh, I barely know how to start with this one. I did work before with github pages, but the only things I actually did was to create a very simple blog-like site using one of those ready to use jekyll themes or to fork a website model (such as Mozilla Study Group repo) and work a little bit on it.

So it will be great to have someone to start this, and we can chat about how the site should be (but I wont be able to help with technical details).

The website should work as a friendly space that our users could use to find and download the courses. That's it. Anything beyond that, like having a form for sending new material or anything useful you can think of would be great, but not essential right now.

Suggestions are welcome, as always. ;)

Oh, and as above with the courses, just ask me if you are willing to help on this and would like to be added as a direct contributor in the repo.

R courses feedback and suggestions

Once we get some courses online, you can all check them out and give feedback about the content, organization or anything else. Even the smallest feedback on the material would be great. On the long term, feedback from those who actually used anything here to teach a course or class would be totally awesome.

If you don't consider yourself an experienced R user, you can (and totally should) help with this too! Feedback for those who are learning is very important, as this project main focus is teaching and learning R.

Anything else that is not listed here

This is an open and collaborative project, so you all should be free to suggest anything about the project, the content, the website, this very guidelines or anything else that you might consider. Every small or big suggestion will be welcomed and considered. This is not my project, it is our project.