Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
42 lines (26 loc) · 815 Bytes

CONTRIBUTING.md

File metadata and controls

42 lines (26 loc) · 815 Bytes

Contributing to OpenSaaS


Contribution Prerequisites

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

Development Workflow

After cloning OpenSaaS, run make init to start working. Please follow Guidelines when writing code.


Several useful commands:

migrations / seeding

  • make migrate
  • make seed

lint

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

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.