Skip to content

Guidance

MCatherine edited this page Jul 24, 2023 · 2 revisions

Contribution Guidance

When we want to add component style changes or make component style changes

  • Make sure we only make necessary changes
    • For Carbon, check the basic component style in the design system, and confirm with the service designer in your team, what's the difference between the one in the design system and the default Carbon style
    • For PrimeVue, compare the difference between the style in the design system and the default primevue style, make changes as needs
  • For any custom styles that only related to your project, do custom style change in your application
  • Use responsive unit "rem" instead of "px"

Create Pull Request Guidance

  • When we create a pull request, title needs to follow the naming convention
  • Must provide detail description of what has been changed
  • Must have another team member to review the changes

Pull Request Review Guidance

  • Check what has been new added
  • Check if there is any style change for the existing components, if it will cause any conflict
  • Check to make sure there is no hard code values

How to test the npm package locally

  • Clone this repository locally
  • Check out to the feature branch you want to test
  • In your own project, make sure to remove the existing @bcgov-nr/nr-fsa-theme package, and then do a local install from where your nr-fsa-theme repo is located, for example npm install /Documents/nr-fsa-theme