Skip to content

contributing.md

Latest commit

 

History

History
91 lines (58 loc) · 3.07 KB

contributing.md

File metadata and controls

91 lines (58 loc) · 3.07 KB
Raw

Contributing Guide to LibreLab

LibreLab is an open source repository designed for students to get themselves involved in Open Source and encourage participation in Hacktoberfest.

With markdown as the primary form of content, LibreLab aims on the making the progress of adding posts to this site via code easy and intuitive for beginners.i

Prerequisites

Regsitering For Hacktoberfest

Step Wise Contribution Process

  1. Get a Github Account

  • if you don't have an account, you can head to github.com and sign up

Github SignUp Image

  1. Fork this repository

Fork Illustration

  1. Clone your forked repository on your machine.

  • Proceed to Github Desktop and click on the option, "clone a repository from the internet", find your forked repository from the list of your repositories and click on clone.

  • Note where your repository will be cloned. This is where you will be making changes/contributions.

Github-desktop

  • After cloning the repository with Github Desktop, you will be presented with the following prompt, Selecting any of the two items shouldn't make much difference for our purpose. You can leave the first option selected if you want.

Clone options

  1. Make the required changes (View the following title 'Making the Necessary Changes' for more)

  2. Submit a Pull Request

  • Go to your forked repository.
  • You should be able to view the option 'Contribute', after you have made the required changes.
  • Click on create pull request and go through the next process to create a Pull Request.

Making the Necessary Changes

  • Please view this video for clarification Youtube Link

  • add a markdown file with the content of your choice to ./content folder

  • after adding the content, goto scripts/contentmap.js and add the following lines of code.

const contentFiles = {
    "<...Existing Content>",
  "<slug-for-your-content>": {
    title: "<for-title>",
    file: "<name-of-yourmarkdown-file>.md",
    image: "./assets/<add suitable image to ./assets and link>",
  },
};

Example:

const contentFiles = {
  "contributing-guide": {
    title: "Contributing to LibreLab",
    file: "contributing.md",
    image: "./assets/contributing illustration.png",
  },
};

Your article should then appear on the home page