opensaas/CONTRIBUTING.md

Create fully bundled SaaS application (Backend & Frontend) using an interactive CLI

# Contributing to OpenSaaS

<br />

## Contribution Prerequisites

- You have Node installed at v12.0.0+.
- You have Node / ReactJS experience.
- You are familiar with Git.

<br />

## Development Workflow

After cloning OpenSaaS, run `make init` to start working.
Please follow [Guidelines](https://ateam-bootcamp.readthedocs.io/en/latest/) when writing code.

<br />

## Several useful commands:

**migrations / seeding**

- `make migrate`
- `make seed`

<br />

**lint**

- `npm run pre-commit` in each one of the services.

<br />

## Submit Changes:

- Create a new branch.
- Use single purpose commits.
- Commit messages should be meaningful.
- Rebase your branch against main branch.
- Prettier your code before committing your changes, by running `npm run pre-commit`.
- Open a pull request to main branch.