Contributing guidelines

Step 1: Fork this repository and clone it

• Install git if you don't have it. Here's an article on how to install git on Windows/Linux/macOS
• Fork the gyan repository and clone it. If you're not sure how to fork or clone a repository, refer to this 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:

  <your-github-username>:
  	name: <your-name>
  	github: <your-github-username>
    author_image: <filename-of-the-image-you-added>
    description: <a-descrtiption-of-your-choice>
    email: <your-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 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 link on resolving merge conflicts or try googling or ask someone on our Slack workspace under the #github channel.