Guide to access the SOHW repo

Welcome!!

First of all thanks for taking time to contribute for SOHW. Before you start, have a look at README.md and CONTRIBUTING.md file to know about how SOHW works.

Step 1: Add yourself as a contributor for our repository

• Navigate to assets —> data —> contributors.yml in the repository
• Include yourself as a contributor as per the following format

 Author_number:
    name: your name
    twitter: your twitter handle
    description: about you (Ex: Contributor to Open Science, Bug reporter, designer, etc)

Step 2: To add a category

• Navigate to assets —> data —> categories.yml
• Check whether the category that you want to contribute is included under categories.yml
• If not, include the category that you wish to add.

Step 3: Fork the Repository

• Fork this repository
• This makes your own version of this project in your github repo
• Make changes in your repo that is been forked from the main repo

Step 4: To write a blog

• Navigate to _post in your forked repository
• Click on Create new file
• Enter the file name as per the following format

  yyyy-mm-dd-name.md (name should not contain any space. Instead, add “-“) e.g.2018-01-01-Hello-world.md

• Include the following format before you write a blog

---
layout: post

#event information
title:  "Title of your blog"
cover: "add image link" (Not want to add cover image then remove it)
date:   yyyy-mm-dd 

#event organiser details
author: "name"
category: "Category name" (e.g. Rust)

---

  your blog content here.....

• Write your blog. Simple formatting syntax can help your blogs to look just awesome
• Click on Commit new file

Step 5: Submit a Pull Request

• Make sure that your forked repository is updated till now as like in master branch
• Click on Pull Request —> New Pull request
• The changes list will be shown down. Check once whether you have included all the files.
• Click on Create Pull Request

Submit a pull request. This opens a discussion around the project and lets the project lead know you are proposing changes. Be sure to add the relevant tests before making the pull request. Docs will be updated automatically when we merge to master, but you should also build the docs yourself and make sure they’re readable.

Hope it’s helpfull :)

Want to see something else added or report a bug? Open an issue.

Happy contributing!! Happy Global Sprinting :D