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: added commit summary restrictions #0 #36

Merged
merged 1 commit into from
Mar 13, 2024

Conversation

rafapaulin
Copy link
Contributor

Proposed Changes

Add a step on GHA to make sure the commit messages are compliant with 42dx's CONTRIBUTING guide.

Contribution type

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update/improvement

Related Issue(s)

  • Closes #0

Motivation, Context and Extra Info

This commit summary restriction step is important, since we rely on them to automatically build our changelog.

On top of that, checking each commit message is impractical, specially considering that this kind of check can be automated :)

Checks

General

  • I have read the org's CONTRIBUTING file
  • All my commit messages follow conventional-commit standards (remember: we use them to auto-generate the CHANGELOG file 😅)
  • I confirmed that there aren't any other open PR about the same issue

Code Standards

  • I have performed a self-review of my own code
  • Code Lint pass locally with my changes
  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas

Documentation and reliability

  • My branch is up to date with the project's base branch
  • I have made corresponding changes to the documentation
  • The documentation changes follow the repository's docs standards
  • My changes generate no new warnings

Testing

  • Existing automated tests pass locally with my changes
  • I have added new unit/integration tests that prove my fix is effective or that my feature works

How to verify the changes

  1. Create a dummy PR, write some non-compliant commit messages and push them
  2. Create a dummy PR, write only compliant commit messages and push them

Screenshots (if appropriate)

N/A

@rafapaulin rafapaulin added the enhancement New feature or request label Mar 12, 2024
@rafapaulin rafapaulin self-assigned this Mar 12, 2024
@rafapaulin rafapaulin force-pushed the chore/0/test-commit-msg-check branch 7 times, most recently from 52f2947 to fe680c5 Compare March 12, 2024 21:08
@github-actions github-actions bot deleted a comment from sonarcloud bot Mar 12, 2024
@rafapaulin rafapaulin force-pushed the chore/0/test-commit-msg-check branch 3 times, most recently from 8a90066 to 4054852 Compare March 12, 2024 21:20
Copy link

sonarcloud bot commented Mar 12, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

Copy link

@rafaelassumpcao rafaelassumpcao left a comment

Choose a reason for hiding this comment

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

LGTM

@rafapaulin rafapaulin merged commit 8410b8a into beta Mar 13, 2024
2 checks passed
@rafapaulin rafapaulin deleted the chore/0/test-commit-msg-check branch March 13, 2024 14:28
Copy link

🎉 This PR is included in version 1.0.0-beta.2 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request released on @beta
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants