Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

chore: remove conventional commit check for PR #950

Merged
merged 1 commit into from
Feb 14, 2024

Conversation

Valentin271
Copy link
Member

This removes conventional commit check for PRs.

Since we use the PR title and description this is useless. It fails a lot of time and we ignore it.

IMPORTANT NOTE: This does not mean Ratatui abandons conventional commits. This only relates to commits in PRs.

@joshka
Copy link
Member

joshka commented Feb 12, 2024

Seems reasonable - how about also modifying the PR check a bit to help guide PR messages? Something like.

Thank you for opening this pull request! Here are some guidelines for writing a good PR message:

- We use the PR message as the default commit message that will be committed to the repository
- We automatically generate the [changelog](...link to changelog) using commits, so please use
  [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) to make this easy:
  - ... examples / specific parts of note
- Writing the perfect PR message is about finding a balance of communicating the problem and
  solution as well as not being too verbose.
- Put yourself in the mindset of the future consumer of this library and what information they need
  to know about this change (it might be very little or nothing beyond the title).
- It's rare that a PR message needs to explain how the change was achieved, and much more
  important to explain the impact on the user, and the rationale for any interesting choices
- If there's info that's useful for reviewing, but not useful for the changelog, move it to followup comment
- If there are changes made to the PR during review, make sure to also update the first PR comment
  (to make it easy to merge)

Perhaps this response should be on every PR?

@Valentin271
Copy link
Member Author

Valentin271 commented Feb 12, 2024

  • We use the PR message as the default commit message that will be committed to the repository
  • We automatically generate the [changelog](...link to changelog) using commits, so please use
    Conventional Commits to make this easy:
    • ... examples / specific parts of note

I think this specifically is a good message to put on PRs with non conventional commits titles.

The whole paragraph would make more sense to me in CONTRIBUTING.md or even better: in the PR template (perhaps as some sort of checklist?)

I think a comment with this on every PR is too much, but I'd be keen on putting it for every first-contributor PR.

EDIT: Also this is the matter of another PR imo

@joshka
Copy link
Member

joshka commented Feb 12, 2024

EDIT: Also this is the matter of another PR imo

yep

I want another maintainer's opinion on this change before merging it btw.

Copy link
Member

@joshka joshka left a comment

Choose a reason for hiding this comment

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

Check with another maintainer before merging this.

Copy link
Member

@orhun orhun left a comment

Choose a reason for hiding this comment

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

Sad to see this go but sounds reasonable 👍🏼

.github/workflows/ci.yml Show resolved Hide resolved
This removes conventional commit check for PRs.

Since we use the PR title and description this is useless.

IMPORTANT NOTE: This does **not** mean Ratatui abandons conventional commits.
This only relates to commits in PRs.
@Valentin271 Valentin271 force-pushed the chore/remove-conventional-check branch from 13ffe9c to f6ebea1 Compare February 14, 2024 17:57
Copy link

codecov bot commented Feb 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (efd1e47) 91.9% compared to head (f6ebea1) 91.9%.
Report is 2 commits behind head on main.

Additional details and impacted files
@@          Coverage Diff          @@
##            main    #950    /-   ##
=====================================
  Coverage   91.9%   91.9%           
=====================================
  Files         61      61           
  Lines      15703   15723    20     
=====================================
  Hits       14436   14456    20     
  Misses      1267    1267           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Valentin271
Copy link
Member Author

Sad to see this go

Every commit on main is made through a PR, internal PR commits don't matter.

What would be great though is to check if the PR title matches the conventional commit style.

@Valentin271 Valentin271 merged commit b0314c5 into main Feb 14, 2024
33 checks passed
@Valentin271 Valentin271 deleted the chore/remove-conventional-check branch February 14, 2024 18:08
@orhun
Copy link
Member

orhun commented Feb 15, 2024

yeah, I think we already do that in check-pr.yml

@Valentin271
Copy link
Member Author

Valentin271 commented Feb 15, 2024

That's right I forgot about that, it's all good then.

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.

4 participants