@favoapp/design v0.6.15

Guideline of Development

Development Workflow

In case you want to add a new functionality the library needs to follow the following steps:

1. Create a branch from develop following the pattern of branch prefixes:

Branch prefixes

Standard prefixes for new branches, to allow automated workflows and make branch types clearer.

• bugfix / - Used for work fixing product bugs
• feature / - Used for work on new feature
• hotfix / - Used for fixing urgent bugs on production, that have high impact
• release / - Used for preparing and testing your work for release

Open a Pull Request for the develop branch

Pull Requests initiate discussion about your commits. Because they're tightly integrated with the underlying Git repository, anyone can see exactly what changes would be merged if they accept your request.

Release e Deploy

Make a package version bump in the develop branch and add git tag, request the PR for master. After automatically approved, the deployment will be done for npm.

Notes:

Merge branches into develop only. Don't merge directly into master.

Only use semver versions in package.json, but stick to MAJOR.MINOR.PATCH (no suffixes, e.g. -beta) otherwise version bumping may produce unexpected results.

FAQ

• When will the package be published in production??

• At any time, just follow the Release and Deploy step. *

• How to test your local library?

• Connect the project to the library using link techniques (yarn / npm). If that doesn't work, see if the problem isn't with the project in question.*

• I would like to see the project's storybook, where can I access it?

• At this point you can only access the location, we will soon set up a place to host our storybook. *