Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
66 lines (44 loc) · 1.72 KB

CONTRIBUTING.md

File metadata and controls

66 lines (44 loc) · 1.72 KB

CONTRIBUTING

We are following Semantic Versioning and Conventional Commits.
When contributing to this repository, please follow the steps below.

Semantic Versioning Reminder

PATCH: refactor, internal or non-breaking change which fixes an issue

MINOR: non-breaking change which adds functionality

MAJOR: fix or feature that would cause existing functionality to not work as expected

Conventional Commits Reminder

Always try to add the library you've been working on between ()

  • For instance, if adding a new component in core package.
git commit -m "feat(core): adding a new component"
  • For instance, if fixing an issue
git commit -m "fix(icons): change correct name to AddUser icon"
  • If touching configuration
git commit -m "chore(dep): updating eslint configuration"

Branches

We already have a develop branch created to work on packages.

⚠️ Don't use or push on main branch. This branch is used to merge and publish packages.

Dev

  • Before starting any development, please rebase the develop branch.
  • Checkout to your own development branch if different from information above.
  • Rebase this branch with develop branch.
  • Start developing.
  • Then, create a Pull Request.

Pull Request

  • After pushing your work, create a Pull Request
  • Select develop branch as base branch.
  • Add a clear title if your commit message is not there.
  • Leave a comment if desired
  • Create your Pull Request and then fill the checkboxes of the Template
  • Add a reviewer or two

What's next ?

  • Release Manager or Maintainer of Edifice UI will merge this PR.
  • Packages will be updated on NPM.