Setup & Installation

Prerequisites

• For both the development & build workflows, nodeJS is required, you can find and install it here (v14.9.0)

Project download

git clone [email protected]:Rnters/frontend-core.git && cd frontend-core

Dependency installation

yarn

Development

Git branches & commit messages

New components and/or developments in existing components should be developed in their down git branch under the following nomenclature:

JIRA-<jira_task_id>/<jira_task_title>

Example:

JIRA-UD-00/lorem-ipsum-dolor

Commit messages follow the conventional commit message format to generate the proper changelog entries; Commits can be feat, fix or chores according to what was developed and being commited; Adding the JIRA task ID will ensure that specific commits and branches are made visible and automatically updated on the respective JIRA task;

feat(<new-component-name>): <descriptive message>
# <Aditional feature/change/chore/fix details or information>
# ...

JIRA-<jira_task_id>

At this time tasks can be feat | chore | fix and although other types can be used, for now we should, unless stated otherwise, restrict to only these options as they are enough to represent the full scope of all tasks that should be created while still matching what we can display on JIRA;

Component boilerplate & development

ToDo:

• [ ] Setup component/util package template (to avoid repetition) (through CLI);
• [ ] Use storybook to aid local development of new components;

Testing

ToDo:

• [ ] Finish unit testing implementation & setup;
• [ ] Develop visual regression testing;

Versioning

Produce a new relase, bumping component/util version and updating the CHANGELOG.md:

yarn release @rnters/<component-name>

Make sure that before releasing a new version you have your NPM registry setup in your machine:

npm addUser

Follow the suggested steps - you will need to be registered on NPM and that your user has been added as a collaborator to Rnters Org;

First time versioning (new components):

git push --follow-tags && npm publish --access=public

Versioning of existing components/utils:

git push --follow-tags && npm publish

Component Usage

yarn add @rnters/<component-name>

Or if you intend on using a specific component or util version, add the following to the devDependencies object in your projects package.json

// package.json

"devDependencies": {
  "@rnters/<component-name>": "1.X.X",
}

And run to update dependencies:

yarn