Skip to content

contributing.md

Latest commit

 

History

History
40 lines (28 loc) · 1.37 KB

contributing.md

File metadata and controls

40 lines (28 loc) · 1.37 KB
Raw

Contributing Guide

Pull Request Guidelines

  • Checkout a branch from the relevant branch, e.g. main, and merge back against that branch.

Development Setup

Starting from 0 (note that you will need administrative privileges to correctly install these):

  1. We recommend vscode to interact with this repository
  2. Install node
  • Check the box to automatically install the nessassary additional tools.
  • Follow the onscreen instructions
  1. Enable powershell: Set-ExecutionPolicy RemoteSigned -Scope CurrentUser
  2. Reboot to ensure installation took.
  3. Install pnpm with: choco install pnpm
  4. We also need git: winget install --id Git.Git -e --source winget
  5. Reboot to ensure installation took.
  6. We use pnpm as our package manager. To get running:
# Clone into ./lynker-spatial-docs
git clone https://github.com/lynker-spatial/docs lynker-spatial-docs
cd lynker-spatial-docs

# Install the project dependencies
pnpm install

# Start the development server
pnpm dev

After running the above, the current site and any changes you make will be available, live, at http://localhost:5173.

For more information on the file structure of this repository, refer to the VitePress documentation on routing.