Skip to content

docs: improve PR title format hint in PR template and CONTRIBUTING.md (#286)#287

Merged
ncarenton merged 1 commit into
mainfrom
docs/286-pr-conventions-hint
Jun 10, 2026
Merged

docs: improve PR title format hint in PR template and CONTRIBUTING.md (#286)#287
ncarenton merged 1 commit into
mainfrom
docs/286-pr-conventions-hint

Conversation

@ncarenton

Copy link
Copy Markdown
Member

Summary

Port of the contributing documentation improvement from OpenCTI connectors (OpenCTI-Platform/connectors@b3b61c0).

The CI already validates PR titles via validate-pr-title.yml, but contributors weren't given a clear reminder of the expected format. This PR surfaces it upfront.

Changes

  • .github/PULL_REQUEST_TEMPLATE.md: add PR title format block inside the opening comment so it's visible before the contributor clears the template
  • CONTRIBUTING.md: expand the "Titles" bullet in the conventions section with a code block, field-by-field breakdown, and examples

Closes #286

…#286)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings June 10, 2026 11:00
@github-actions github-actions Bot added the filigran team Item from the Filigran team. label Jun 10, 2026
@codecov

codecov Bot commented Jun 10, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 73.19%. Comparing base (573051a) to head (5d074fc).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #287   +/-   ##
=======================================
  Coverage   73.19%   73.19%           
=======================================
  Files          53       53           
  Lines        2350     2350           
=======================================
  Hits         1720     1720           
  Misses        630      630           
Flag Coverage Δ
connectors 73.19% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

This PR improves contributor-facing documentation to make the repository’s Conventional Commit-style PR title format (including required issue reference) more visible at PR creation time and clearer in contributing guidelines.

Changes:

  • Adds a PR title format reminder to the top comment of .github/PULL_REQUEST_TEMPLATE.md
  • Expands the “Titles” convention in CONTRIBUTING.md with a format block, field breakdown, and examples

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
CONTRIBUTING.md Expands the titles convention with a dedicated format block and examples.
.github/PULL_REQUEST_TEMPLATE.md Surfaces the expected PR title format at the top of the PR template for contributors.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .github/PULL_REQUEST_TEMPLATE.md
Comment thread CONTRIBUTING.md
@ncarenton ncarenton merged commit a365356 into main Jun 10, 2026
15 of 16 checks passed
@ncarenton ncarenton deleted the docs/286-pr-conventions-hint branch June 10, 2026 12:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

filigran team Item from the Filigran team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: improve PR title format hint in PR template and CONTRIBUTING.md

3 participants