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

Update Style Guide to Ensure that PR Titles are Useful #11284

Merged
merged 2 commits into from
Nov 17, 2023

Conversation

Mab879
Copy link
Member

@Mab879 Mab879 commented Nov 16, 2023

Description:

  • Update style guide for PR Titles
  • Fix wording around merge commits

Details are in each commit as well.

Rationale:

  • Ensure that the change log is usable.
  • Keep the style guide readable

PR titles are used in the change log we should add a rule to ensure that
the titles are useful to the readers of the change log.
@Mab879 Mab879 added the Documentation Update in project documentation. label Nov 16, 2023
@Mab879 Mab879 added this to the 0.1.71 milestone Nov 16, 2023
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

Copy link

codeclimate bot commented Nov 16, 2023

Code Climate has analyzed commit a300203 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 58.8%.

View more on Code Climate.

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.

Great. Thanks

@marcusburghardt marcusburghardt merged commit 54c18cc into ComplianceAsCode:master Nov 17, 2023
38 checks passed
@Mab879 Mab879 deleted the styleguide_pr_title branch November 17, 2023 13:14
@marcusburghardt marcusburghardt self-assigned this Nov 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Update in project documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants