CONTRIBUTING.MD

Flexilla (flexilla) Contributing Guide

Every contribution is welcome to this open source project. However, before submitting your contribution, be sure to take a moment and read the following guidelines.

• Flexilla (flexilla) Contributing Guide
  • Don't know how to contribute or new to Open Source?
  • commit-convention
  • Pull Request Guidelines
    • Steps to PR
  • Local Development
    • Build packages

Don't know how to contribute or new to Open Source?

Take a look at :

1. How to Contribute to Open Source
2. How to Contribute to an Open Source Project on GitHub

Have a question?

1. Check our Github Issues to see if someone has already answered your question.
2. Go to the Discord Server
3. Or Contact one of maintainers

Prerequisites

• Code Editor
• NodeJS

Tools

2. Vite JS
3. Lerna

commit-convention

Read this

Pull Request Guidelines

• The main branch is basically a snapshot of the latest stable version. All development must be done in dedicated branches.

Steps to PR

1. Fork of this repository and clone your fork

2. Create a new branch out of the main branch.

3. Make and commit your changes following the commit convention.

Local Development

After cloning the repository, execute the following commands in the root folder:

1. Setup

Make sure to install the dependencies:

npm run setup

Build packages

npm run build

Build a single package

Navigate to the needed package and run

npm run build

or

npx lerna run build -scope=@flexilla/packageToBuild