Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

CI: Enable commit linting #376

Merged
merged 1 commit into from
Apr 26, 2024
Merged

CI: Enable commit linting #376

merged 1 commit into from
Apr 26, 2024

Conversation

reb-dev
Copy link
Collaborator

@reb-dev reb-dev commented Apr 25, 2024

Commits should have the following format:

<type> | <scope>: <subject>

Rules:

  • type can be any of the following:
    Core, Component, Container, Utils, Styles - for core library changes
    Angular, React, Svelte, Vue - for wrapper related changes
    Website - for changes related to website content
    Dev, Shared - for changes to the demo app, dev tools or integrations
    CI - for CI/CD pipeline related changes
    Release - for release commits
    Misc - anything else
    
  • scope should be the name of the component or feature being worked on in PascalCase
  • Additional scope values can be added with | delimiter
  • subject is a short description of the change in Sentence case
  • A reference <#issue> may also be provided on the next line
  • No leading or trailing whitespace in the header

Linter warnings:

  • Scope is optional but encouraged for all types except CI or Release
  • For Component type, scope should be one of the component names

Some examples:

Core | Utils: Refactoring shape rendering helpers
Component | Timeline: Fixing enter transition bug
Dev | Build: Upgrading rollup dependency
React | Autogen: Tweaking component lifecycle logic
Release: 1.4.0
Website | Gallery: Adding a new example
Website | Docs | Axis: Updating some property description

@reb-dev reb-dev mentioned this pull request Apr 25, 2024
@lee00678
Copy link
Collaborator

I went through this and I didn't find any obvious issues. Though this is more like a learning experience to me.

lee00678
lee00678 previously approved these changes Apr 26, 2024
@reb-dev reb-dev merged commit 81b2546 into main Apr 26, 2024
4 checks passed
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants