inSileco / inSileco.github.io

:globe_with_meridians: Our blog powered by blogdown
https://blog.insileco.io/
GNU General Public License v3.0
8 stars 1 forks source link

add a *how to contribute* section #36

Closed KevCaz closed 6 years ago

KevCaz commented 6 years ago

This should include all the information to contribute efficiently to the post. For instance, it will cover:

  1. how to proceed for new contributors as @david-beauchesne explains in:

Ok, so we need to update the authors/contributors for the site. It is quite simple, you need to fill in a separate yaml file per author. Go to ./data/authors/, copy a file there and fill out the yaml header with your information. Push and commit your newly created yaml file with your name as the file name. Keep the name super(!!) simple, it's what we use in the posts to identify authors. The website will be automatically updated once you add in your information.

  1. how we should proceed, direct push on the dev branch or a PR process? (I'd suggest the latter);

  2. how files should be named;

  3. etc.

KevCaz commented 6 years ago

I am adding a CONTRIBUTING files in the repo. Please comment and edit. If you feel something important is missing, please open a separate issue.