Skip to content

Modernize CONTRIBUTING.md for OpenVox#154

Merged
tuxmea merged 2 commits intoOpenVoxProject:masterfrom
miharp:feat/modernize-contributing
May 5, 2026
Merged

Modernize CONTRIBUTING.md for OpenVox#154
tuxmea merged 2 commits intoOpenVoxProject:masterfrom
miharp:feat/modernize-contributing

Conversation

@miharp
Copy link
Copy Markdown
Contributor

@miharp miharp commented May 5, 2026

Closes #153

Summary

  • Replaces Puppet-branded content and dead links (JIRA tracker, docs@puppet.com) with GitHub Issues and PR workflow
  • Adds GPG signing (-S) and DCO sign-off (-s) requirements with setup instructions
  • Adds local preview section with Ruby 3.2+ requirement and rbenv/rvm pointers
  • Replaces AP Style reference with the Google developer documentation style guide
  • Condenses prescriptive topic-structure guidelines into concise writing tips
  • Drops the Headings section (covered by markdownlint and the Google style guide)
  • Links to GitHub's forking workflow guide
  • Notes that fenced code blocks must include a language identifier

Test plan

  • All external links resolve
  • npx markdownlint-cli2 CONTRIBUTING.md passes

- Replace Puppet-branded content and dead links (JIRA, docs@puppet.com)
  with GitHub Issues and PR workflow
- Add GPG signing and DCO sign-off requirements
- Add local preview instructions with Ruby version requirement
- Replace AP Style reference with Google developer documentation style guide
- Trim prescriptive topic-structure guidelines in favor of concise writing tips
- Link to GitHub's forking workflow guide

Signed-off-by: Michael Harp <mike@mikeharp.com>
@miharp miharp marked this pull request as ready for review May 5, 2026 13:05
@miharp miharp requested a review from a team as a code owner May 5, 2026 13:05
@tuxmea tuxmea merged commit 0a2f201 into OpenVoxProject:master May 5, 2026
4 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.

Modernize CONTRIBUTING.md for OpenVox

2 participants