Development Workflow - MaritzSTL/chameleon GitHub Wiki

Here is the development workflow for contributing to Chameleon:

  • Create a feature branch from master
  • Begin work on issue/feature
  • Before creating pull request, run the bump-versions command to bump versions accordingly and build-storybook to update docs/storybook and commit the results to your branch
  • Create pull request into master
  • Pass all PR checks
  • PR author merges their own pull request, or if a community contributor, a Member will merge upon verifying checks
  • Author publishes to npm with publish-packages, or if a community contributor, pings a Member to do it on their behalf

When creating a pull request, please make sure you include a description that describes what you are changing. Before submitting, please use the following checklist:

  • All elements build properly
  • All unit tests pass successfully
  • Versions have been bumped appropriately
  • Storybook and docs are updated appropriately

Chameleon uses Semantic Versioning in order to ensure that changes introduced are backwards compatible and that bug fixes and patches are applied consistently. As a general rule of thumb, you can use the following to determine how to bump the version:

Introducing a change that breaks an existing API or functionality - Major (1.0.0 => 2.0.0) Introducing a change or functionality that is backwards compatible - Minor (1.0.0 => 1.1.0) Editing existing functionality or fixing a bug - Patch (1.0.0 => 1.0.1)