Skip to content

Latest commit

 

History

History
39 lines (24 loc) · 1.12 KB

CONTRIBUTING.md

File metadata and controls

39 lines (24 loc) · 1.12 KB

Contributing to svelte-notifications

This document will go through how you can contribute to svelte-notifications

Getting started

1. Fork the repository

To start off, you need to fork this repository. This can be done by hitting the Fork button in the upper right hand corner.

2. Clone your fork

After forking the repository, you can now clone your fork to your local machine.

3. Install dependencies

Before you can run the project, you need to install the dependencies. To do this, make sure you have Node installed. Then you can run this in the root of the project.

npm install

Running the project

To run the project in development mode, you can start by runing this in the root of the project.

npm run dev

If the script runs successfully, you should now be able to visit http://localhost:5000 and see the development website.

Submitting a pull request

When you're done with fixing a issue or implementing a new feature, create a new commit, and push to your local fork. After that you can then go ahead and submit a PR to the original repository.