Skip to content

Commit

Permalink
Point to docs in contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
WillHannon-MCB committed Apr 11, 2024
1 parent b578c2c commit 8034eb0
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ Welcome to the `dms-viz` project! [dms-viz](https://dms-viz.github.io/) is an in
to
2. An interactive web-based visualization tool written with Javascript.

This repository contains the code for the interactive visualization component of dms-viz. We are always looking for ways to improve and are happy to welcome contributions from the community.
This repository contains the code for the interactive visualization component of `dms-viz`. We are always looking for ways to improve and are happy to welcome contributions from the community.

Detailed instructions for contributing to the `dms-viz` project are available in the documentation [here](https://dms-viz.github.io/dms-viz-docs/).

## Getting Started

Expand All @@ -20,13 +22,13 @@ To begin contributing, follow these steps:

2. Install the necessary dependencies specified in the package.json file by running the command:

```
```bash
npm install
```

To start development, you'll need to run the local server using Vite. This can be done with the command:

```
```bash
npm run dev
```

Expand All @@ -47,4 +49,4 @@ Remember to fetch the latest changes from the main repository before you start w

## Code Guidelines

We aim for clean and consistent code across the entire project. To this end, we use `ESLint` for linting and `Prettier` for code formatting. Make sure to install these extensions to your code editor. Before making a Pull Request, ensure your code adheres to these formatting guidelines.
We aim for clean and consistent code across the entire project. To this end, we use `ESLint` for linting and `Prettier` for code formatting. Make sure to install these extensions in your code editor. Before making a Pull Request, ensure your code adheres to these formatting guidelines.

0 comments on commit 8034eb0

Please sign in to comment.