# How to contribute to Harmonica Hangout Docs

Prerequisites
Clone Repository
Install Dependencies
Build & watch files for changes
Add or edit content in a new branch
Key VuePress Documentation

# Prerequisites

Knowledge of Git, Markdown, and JavaScript helpful
Have Node.js installed
Have npm or yarn installed
See VuePress Prerequisites Documentation (opens new window)

# Clone Repository

Clone Harmonica Hangout Docs (opens new window)
Change to the develop branch git checkout develop

# Install Dependencies

Navigate to the repo's docs directory cd ~/<repo-location>/docs/
Run npm install or yarn install to install dependencies

# Build & watch files for changes

Run npm run dev or yarn dev to start a watcher that builds site files
If successful, a page should be served at website address localhost:8080
The site should rebuild automatically as you add and edit files

# Add or edit content in a new branch

Content is stored in ~/<repo-location>/docs/src
See VuePress Directory Structure Documentation (opens new window) for more info on how this folder is structured
Create a new git branch for your changes git branch <descriptive-branch-name>
- Make sure you're on the develop branch first
Make your additions and changes, add them to the git repo git add ..., and commit with a description message git commit -m "Adds x content"
Push your changes git push origin <descriptive-branch-name>
Create a pull request for your changes

# Key VuePress Documentation