Skip to content

Conversation

@trenner1
Copy link
Contributor

@trenner1 trenner1 commented Feb 4, 2025

Description

This PR introduces PR title rules following the Conventional Commits standard for The Herald bot. The goal is to ensure consistency, maintainability, and automation in the commit and release process.

Changes Introduced

  • Added a Pull Request (PR) guidelines document defining title conventions.
  • Enforced Conventional Commits formatting for PR titles.
  • Provided examples of PR types relevant to DevSecOps and bot development.
  • Ensured alignment with The DevSec Blueprint (DSB) best practices.

Why This is Important

  • Helps automate release note generation.
  • Improves commit history readability.
  • Reduces merge conflicts in release_notes.md.
  • Ensures structured contribution standards for The Herald bot.

How to Test

  1. Open a new PR in The Herald repository.
  2. Ensure the PR title follows this format:
    <type>([optional scope]): <description>
    
  3. Verify that the PR aligns with the documented PR rules.

Example PR Titles

  • feat(commands): Add role-based access control
  • fix(auth): Resolve incorrect token expiration handling
  • docs(readme): Add setup guide for contributors
  • ci(workflows): Update deployment pipeline with security scans

PR_RULES.md Outdated

---

Would you like any modifications or additional details included?
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This question is for you Damien. I wasn't sure if I captured everything or if the style matched what you were envisioning.

Copy link
Contributor

Choose a reason for hiding this comment

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

Nope! This is PERFECT ❤️

PR_RULES.md Outdated

---

Would you like any modifications or additional details included?
Copy link
Contributor

Choose a reason for hiding this comment

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

Nope! This is PERFECT ❤️

@damienjburks damienjburks merged commit 780101d into devsecblueprint:main Feb 5, 2025
3 checks passed
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