Skip to content

Latest commit

 

History

History
44 lines (26 loc) · 1.16 KB

CONTRIBUTING.md

File metadata and controls

44 lines (26 loc) · 1.16 KB

Contributing to this repository

Getting Started

Before you begin:

  • This project uses Node.js. Make sure you have NodeJS version 12 or above for best support.
  • This project uses yarn package manager, so make sure you have it installed.
  • Checkout the issues page and see if there are any issues that you could work on.

Prerequisites

Knowing any of the following skills mean you are eligible to make a contribution:

  • VueJS
  • NuxtJS
  • MatterJS
  • Physics (and math)

Types of Contributions

  • Discussions
  • Pull Requests (bug fix, feature, code refractor)
  • Issues (bug report, feature request, etc)

Setting up Workspace

Setting up your workspace is really straightforward.

Fork the repository

https://docs.github.com/en/github/getting-started-with-github/fork-a-repo

Clone the fork on your PC

git clone https://github.com/<username>/physics-lab

Install dependencies

yarn install

And... you are done!

You can now make some changes and make a Pull Request.