Skip to content

Latest commit

 

History

History
32 lines (20 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

32 lines (20 loc) · 1.83 KB

Welcome to our contributing guide

Thank you for taking the time to contribute to the project. In this guide you will get a basic understanding of the workflow including opening issues, creating PRs, and merging the PR.

Contributor Guide

To better understand what this project is about, please refer to the README. Below you will find some resources to help get started with open contribution:

Getting Started

Create a new issue

If you see any bugs or features you would like to contribute a solution for, search under the issues to see if it already exists. Kindly open an issue only if there is no existing one.

Solving Issues

Feel free to look through existing issues and pick any that might interest you. Using labels, you can find better suited issues.

Setting up

This repository requires Visual Studio Code and Node.js. Once you have installed these,

  1. Fork the repository
  2. Open a new terminal navigate to the directory you desire to clone the repository. Using git clone <repository> clone the branch you want to work from.
  3. Open the directory in file explorer, and open the git repository titled static-site-generator in Visual Studio Code.
  4. Open the terminal in Visual Studio Code(ctrl+shift+\ , and install the dependencies npm install
  5. If this is your first time running the application, run num run build followed by annpm link or npm link -f.
  6. The application should not be able to run.