zehzo / conectados

Docs 📄

• Figma

Requirements ⚙️

• Yarn

• Node.js

• Check out how to set up the environment to run on the documentation

Installation ⬇️

# Install dependencies

$ yarn

Running the app 🏃

$ yarn dev

Test 🧪

# unit tests

$ yarn test

# unit tests watch

$ yarn test:watch

Contribute 🤝

Branches

Pull requests should be composed of type, number of task and branch name.
Branch name must be spaced by "-".
The types might be:

• feature - For new features
• fix - For adjustments (both bugfixes and hotfixes)
• release - For release branches

Example: feature/14-navbar-mobile

Commits

Commits should be structured as <branch-type>(<branch-name>): <commit description> <task-code>

Example: git commit -m "feature(navbar-mobile): adding smooth scroll" -m "#14"

Default Branches

• master - Most stable code
• develop - Most recently developed

Pull requests

Pull requests must have good descriptions.
The three main topics of the description are:

• What I did
• How I did
• How to test

Of course it's not mandatory, sometimes it won't make sense to add some of these.
But add descriptive PRs with pictures and referencing code when needed.

Scripts

Create a new component:

  yarn generate component

Create a new page:

  yarn generate page

Create a new layout:

  yarn generate layout