Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ieee-nitk/gyan

Last synced: 4 days ago
JSON representation

Host: GitHub
URL: https://github.com/ieee-nitk/gyan
Owner: IEEE-NITK
License: mit
Created: 2020-12-13T17:28:04.000Z (about 4 years ago)
Default Branch: master
Last Pushed: 2021-11-18T19:41:33.000Z (about 3 years ago)
Last Synced: 2023-08-04T00:43:48.142Z (over 1 year ago)
Language: CSS
Size: 6.59 MB
Stars: 0
Watchers: 6
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Contributing guidelines
### Step 1: Fork this repository and clone it
- Install git if you don't have it. Here's an [article](https://www.digitalocean.com/community/tutorials/how-to-contribute-to-open-source-getting-started-with-git) on how to install git on Windows/Linux/macOS
- Fork the [gyan repository](https://github.com/IEEE-NITK/gyan) and clone it.
If you're not sure how to fork or clone a repository, refer to [this](https://www.digitalocean.com/community/tutorials/fork-clone-make-changes-push-to-github) article or do some googling on your own, or ask someone on our Slack workspace under the #github channel.
### Step 2: First-time authors
If you're not a first time author, feel free to skip to the next section.

- Add your image to the `assets/img/authors` folder and make sure you have a square image.
- Open the file `_data/authors.yml` and add your details at the end of the file in the following format:
```
:
name:
github:
author_image:
description:
email:
```
### Step 3: Adding the post
- Create a new `.md` file in the `_posts` folder and name it in the following format:
`year-month-date-title-of-your-choice.md`
- Add content to your new post in markdown syntax. Refer to [this](https://guides.github.com/features/mastering-markdown/) link about Github's flavor of markdown or try googling it if you're not familiar with markdown. Here's an example:
```
---
layout: post
title: "My first internship"
author_github: githubuser123
date: 2017-05-14 23:32:44
image: '/assets/img/'
description: 'A Final Year's advice to juniors on how to ace the internship season'
tags:
- IEEE NITK
- CompSoc
- Internship
categories:
- Compsoc/Diode/Piston
github_username: 'githubuser123'
---
Be confident about whatever you've learnt. Do not hesitate to contact your seniors for
advice. Do not stress. All the best.
```
- A post consists of the head and the body:
#### Head:
- layout : should always be set to "post"
- title : title of your post
- author_github : your github username
- date : today's date in the format '2020-04-25 17:30:30 '
- image : location of the images, should always be set to 'assets/img/'
- description : a description of your post
- tags : post tags
- categories : categories your post belongs to
- github_username : your github username
#### Body:
- This is where your content goes. In Github's flavor of markdown.

### Step 4: Pushing your article to the repository
- Create a new branch in your local repository and commit your changes to it.
- Push the newly created branch to the main repository and create a Pull Request
- When making the pull request follow this:
- Title : New article: (post title)
- Description : A short description about your article

Resolve merge conflcts in your Pull Request, if any. Refer to [this](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-on-github) link on resolving merge conflicts or try googling or ask someone on our Slack workspace under the #github channel.