Skip to content

ci: enable gitlint#20

Merged
gmarull merged 1 commit intopebble-dev:mainfrom
teslabs:add-gitlint
Feb 13, 2025
Merged

ci: enable gitlint#20
gmarull merged 1 commit intopebble-dev:mainfrom
teslabs:add-gitlint

Conversation

@gmarull
Copy link
Collaborator

@gmarull gmarull commented Feb 13, 2025

Applied rules:

  • Built-in rulles: all defaults, except:

    • Do not ignore cleanup commits (conflicts with CC2)
    • Do not ignore merge commits (they will fail with the rule below)
    • Custom title regex, enforce area[/subarea]: description, e.g. docs: add new GSG guide, drivers/qspi: fix quad-line access, etc.
  • Contrib rules:

    • CC1: require Signed-off-by (DCO)
    • CC2: no cleanup commits (fixup!, squash!, amend!)

Ref. https://jorisroovers.com/gitlint/latest/rules/

Applied rules:

- Built-in rulles: all defaults, except:

  - Do not ignore cleanup commits (conflicts with CC2)
  - Do not ignore merge commits (they will fail with the rule below)
  - Custom title regex, enforce `area[/subarea]: description`, e.g.
    `docs: add new GSG guide`, `drivers/qspi: fix quad-line access`, etc.

- Contrib rules:

  - CC1: require Signed-off-by (DCO)
  - CC2: no cleanup commits (fixup!, squash!, amend!)

Ref. https://jorisroovers.com/gitlint/latest/rules/

Signed-off-by: Gerard Marull-Paretas <gerard@teslabs.com>
@gmarull gmarull requested review from Hexxeh and jwise February 13, 2025 09:30
@gmarull gmarull mentioned this pull request Feb 13, 2025
@jwise
Copy link

jwise commented Feb 13, 2025

LGTM. Re:

note we should avoid using branches upstream for PRs; otherwise every upstream fetch may pull random stuff

I find it mostly convenient with small numbers of developers (this is how X1Plus works, for instance, and it makes it more convenient for multiple people to be committing to / hacking on a WIP branch that is not ready to merge yet) but I guess it does not scale for large numbers of developers. Luckily we do not have to decide that for sure here :)

Copy link

@jwise jwise left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@gmarull
Copy link
Collaborator Author

gmarull commented Feb 13, 2025

LGTM. Re:

note we should avoid using branches upstream for PRs; otherwise every upstream fetch may pull random stuff

I find it mostly convenient with small numbers of developers (this is how X1Plus works, for instance, and it makes it more convenient for multiple people to be committing to / hacking on a WIP branch that is not ready to merge yet) but I guess it does not scale for large numbers of developers. Luckily we do not have to decide that for sure here :)

I find upstream branches useful if there's a public-shared development topic not in main yet ("topic" branches), for other stuff forks are much cleaner, also the standard way to contribute regardless of membership level. It's also easy to check out a PR without touching remotes, git fetch upstream pull/N/head:my-local-branch.

@gmarull gmarull merged commit 64ad4b7 into pebble-dev:main Feb 13, 2025
2 checks passed
@gmarull gmarull deleted the add-gitlint branch February 13, 2025 09:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants