Skip to content

Latest commit

 

History

History
146 lines (106 loc) · 3.32 KB

CONTRIBUTING.md

File metadata and controls

146 lines (106 loc) · 3.32 KB
Raw

Contributing to Open Science MOOC website

Welcome message here.

Table of Contents

  1. Before you contribute
  2. How to contribute
  3. Adding content
    1. How to add a person to be listed/rendered on the website
    2. Altering the module content
  4. Help with the development
    1. Setting up your environment
    2. Style guide
  5. Report issues/bugs

Before you contribute

TODO

  • Talk about CoC
  • How to use Git
  • How to use Markdown

How to contribute

Adding content

How to add a person to be listed/rendered on the website

Create a file in _people folder (e.g jon_tennant.md). Make sure there's no uppercase and that you replace every space characters with an underscore.

Inside your file add the following:

---
title: "Your name"
role: "Your role"
team: team_name
location: "Your location"
contact:
  email: "[email protected]"
  github: "username"
  impactstory: "0000-0000-0000-0000"
  linkedin: "username"
  orcid: "0000-0000-0000-0000"
  twitter: "username"
  website: "yourwebsite.com"
---

My fancy bio in [markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) format.

Here's an example:

---
name: Lisa Hehnke
location: Germany
contact:
  email: [email protected]
  github: lhehnke
  orcid: 0000-0002-4103-0658
  twitter: DataPlanes
  website: dataplanes.org
team: steering-committee
---

My fancy bio in [markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) format.

  • team

    There's two possible values: steering_committee or production.

Altering the module content

Modules descriptions are rendered from markdown files located in the _modules folder. The module markdown files are plain markdown file. However, the top of each file contains some YAML data helping to render the content on the website.

---
title: 
  main: "Open Research Software"
  extra: "& Open Source"
module:
  color: "blue"
  status: "in progress"
weight: 1
---

  • title

    • main

      Any text. It will be displayed in regular font size

    • extra

      Any text. It will be displayed in blod font size

  • module

    • color

      Here's the possible value: name the colors

  • weight

    A digit. It represent the order in each the module will be displayed. Lower digits are displayed first.

Setting up your environment

Installing Jekyll

To install Jekyll, we suggest that you read the installation guide on their website. It should guide you through the install of Jekyll and it's dependencies on Windows, MacOS or Linux.

If you have any questions or problems with the install process don't hesitate to open an issue on this repository and would be glad to help you.

Get a copy of the source code

TODO

  • How to create a fork
  • How to git clone

Workflow

TODO

  • add upstream
  • Keep master branch in sync with upstream
  • Always use a different branch to work on your modification

Style guide

TODO

  • Add examples of code style

Contribution review process