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.

Sign up for GitHub

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

Jump to bottom

Introduce style guidelines for commit messages #10220

Merged
merged 1 commit into from
Feb 20, 2023
Merged

Introduce style guidelines for commit messages #10220

merged 1 commit into from
Feb 20, 2023

Conversation

freddieRv
Copy link
Contributor

Description:

  • Introduce a "Commit messages" section under the "Pull requests" style guidelines

Rationale:

  • There are quite a few commits on the project with less-than-ideal commit messages
  • Having style guidelines enforced to some degree will definitely have a positive impact on the overall maintainability of the project
  • Having well-formatted and consistent commit messages makes the log easier to read and use

Review Hints:

@github-actions
Copy link

Start a new ephemeral environment with changes proposed in this pull request:

Fedora Environment
Open in Gitpod

Oracle Linux 8 Environment
Open in Gitpod

@Mab879 Mab879 added this to the 0.1.67 milestone Feb 16, 2023
@Mab879 Mab879 added the Documentation Update in project documentation. label Feb 16, 2023
Mab879
Mab879 reviewed Feb 16, 2023
View reviewed changes
Copy link
Member

@Mab879 Mab879 left a comment

Choose a reason for hiding this comment

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

Thanks for the PR. Please take look comments and let me know what you think.

docs/manual/developer/04_style_guide.md Outdated Show resolved Hide resolved
docs/manual/developer/04_style_guide.md Outdated Show resolved Hide resolved
docs/manual/developer/04_style_guide.md Show resolved Hide resolved
docs/manual/developer/04_style_guide.md Outdated Show resolved Hide resolved
@Mab879
Copy link
Member

Mab879 commented Feb 16, 2023

/packit retest-failed

@freddieRv
Introduce commit messages style guidelines
59005a6 
Having well-formated and consistent commit messages
makes the log easier to read and use.

Signed-off-by: Federico Ramirez <federico.r.ramirez@oracle.com>
@codeclimate
Copy link

codeclimate bot commented Feb 16, 2023

Code Climate has analyzed commit 59005a6 and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 100.0% (50% is the threshold).

This pull request will bring the total coverage in the repository to 51.7% (0.0% change).

View more on Code Climate.

marcusburghardt
marcusburghardt approved these changes Feb 17, 2023
View reviewed changes
Copy link
Member

@marcusburghardt marcusburghardt left a comment

Choose a reason for hiding this comment

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

I liked it.

@marcusburghardt marcusburghardt self-assigned this Feb 20, 2023
@marcusburghardt marcusburghardt merged commit 0c8d9f0 into ComplianceAsCode:master Feb 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Mab879 Mab879 Mab879 left review comments

@marcusburghardt marcusburghardt marcusburghardt approved these changes

Assignees

@marcusburghardt marcusburghardt

Labels
Documentation Update in project documentation.
Projects
None yet
Milestone
0.1.67
Development

Successfully merging this pull request may close these issues.
3 participants
@freddieRv @Mab879 @marcusburghardt