Skip to content

Conversation

@aneta-petrova
Copy link
Member

What changes are you introducing?

Adding a new issue template to make it easier, or even encourage, requesting Vale rules for the project-specific Vale style package.

Why are you introducing these changes? (Explanation, links to references, issues, etc.)

Just an idea I just had.

Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)

N/A

Contributor checklists

  • I am okay with my commits getting squashed when you merge this PR.
  • I am familiar with the contributing guidelines.

Please cherry-pick my commits into:

  • Foreman 3.17/Katello 4.19
  • Foreman 3.16/Katello 4.18 (Satellite 6.18)
  • Foreman 3.15/Katello 4.17
  • Foreman 3.14/Katello 4.16 (Satellite 6.17; orcharhino 7.4)
  • Foreman 3.13/Katello 4.15 (EL9 only)
  • Foreman 3.12/Katello 4.14 (Satellite 6.16; orcharhino 7.2 on EL9 only; orcharhino 7.3)
  • We do not accept PRs for Foreman older than 3.12.

@github-actions github-actions bot added Needs tech review Requires a review from the technical perspective Needs style review Requires a review from docs style/grammar perspective labels Dec 17, 2025
@github-actions
Copy link

github-actions bot commented Dec 17, 2025

The PR preview for a13d28c is available at theforeman-foreman-documentation-preview-pr-4550.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

Copy link
Contributor

@maximiliankolb maximiliankolb left a comment

Choose a reason for hiding this comment

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

I like this idea. I suggest to add a third requirement between the description and optional implementation details: Add two positive and two negative test cases. They could help to implement the rule and showcase what Vale should catch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Needs style review Requires a review from docs style/grammar perspective Needs tech review Requires a review from the technical perspective

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants