CONTRIBUTING.md

We're really glad you're reading this, because we need volunteer developers to help this project come to fruition. 👏

Instructions

These steps will guide you through contributing to this project:

• Fork the repo

• Clone it and install dependencies

    git clone https://github.com/MicroControlLab/lab-gui
    npm install
  

Keep in mind that after running npm install the git repo is reset. So a good way to cope with this is to have a copy of the folder to push the changes, and the other to try them.

Make and commit your changes. Make sure the commands npm run build and npm run test:prod are working.

Finally send a GitHub Pull Request with a clear list of what you've done (read more about pull requests). Make sure all of your commits are atomic (one feature per commit).

NPM scripts

• npm t: Run test suite
• npm start: Run npm run build in watch mode
• npm run test:watch: Run test suite in interactive watch mode
• npm run test:prod: Run linting and generate coverage
• npm run build: Generate bundles and typings, create docs
• npm run lint: Lints code
• npm run commit: Commit using conventional commit style (husky will tell you to use it if you haven't 😉)

Documentation of Dependencies

• react-plotly