Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
143 lines (85 loc) · 7.4 KB

CONTRIBUTING.md

File metadata and controls

143 lines (85 loc) · 7.4 KB

Contributing to Minerva Facilities

How to contribute

You can contribute to Minerva Facilities in various ways, including:

  • Reporting bugs or issues on GitHub. Please make sure to include fill in all the details in the issue template to make sure the issue can be addressed as quickly as possible.
  • Looking at existing issues and adding more information, particularly helping to reproduce the issues.
  • Submitting a pull request with a bug fix or an improvement.

Please read Steps to Contribute & Understanding Good Commit Message

Setting up the repository for development

  1. Fork the repository and create a feature branch.
  2. Clone the Forked Repository.
  3. You can then run yarn install && yarn start in the root folder to start watching and automatically re-building packages when there are new changes.

Submitting a pull request

To submit a pull request:

  1. Write the description of your pull request. Make sure to include a test plan and test your changes.
  2. Make sure all tests pass on -TESTING PLATFORM-.
  3. Wait for a review and adjust the code if necessary.

Available Scripts

In the project directory, you can run:

yarn install

Used to install all dependencies for a project.
This is most commonly used when you have just checked out code for a project, or when another developer on the project has added a new dependency that you need to pick up.

yarn add <package...>

This will install one or more packages in your dependencies.
This will also update your package.json and your yarn.lock so that other developers working on the project will get the same dependencies as you when they run yarn or yarn install.

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

🚀 Deployment

yarn deploy

This section has moved here