Skip to content

docs: add OSS best practices and community health files#60

Merged
rubenmarcus merged 10 commits intomainfrom
feat/oss-best-practices
Jan 30, 2026
Merged

docs: add OSS best practices and community health files#60
rubenmarcus merged 10 commits intomainfrom
feat/oss-best-practices

Conversation

@rubenmarcus
Copy link
Copy Markdown
Member

Summary

This PR adds standard open source community health files and improves CI/CD:

  • SECURITY.md: Security policy and vulnerability reporting guidelines
  • CODE_OF_CONDUCT.md: Contributor Covenant code of conduct
  • Issue templates: Bug report, feature request, and configuration issue templates
  • PR template: Standardized pull request template
  • Dependabot: Automated dependency updates for npm and GitHub Actions
  • CODEOWNERS: Code ownership configuration
  • CI improvements: Matrix testing (Node 18/20/22) and security scanning (npm audit + CodeQL)
  • RELEASING.md: Documentation of the release process

Commits

  1. docs: add SECURITY.md for vulnerability reporting
  2. docs: add CODE_OF_CONDUCT.md with Contributor Covenant
  3. docs: add GitHub issue templates
  4. docs: add pull request template
  5. chore: add Dependabot configuration
  6. chore: add CODEOWNERS file
  7. ci: add matrix testing and security scanning
  8. docs: add RELEASING.md with release process documentation

Test plan

  • Verify issue templates render correctly on GitHub
  • Verify PR template appears when creating new PRs
  • Verify CI workflow runs with matrix strategy
  • Verify Dependabot creates PRs for outdated dependencies

🤖 Generated with Claude Code

rubenmarcus and others added 8 commits January 30, 2026 02:15
Add security policy with:
- Supported versions table
- Vulnerability reporting process
- Response timeline expectations
- Credential handling practices
- Best practices for users

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Bug report template with version, OS, and reproduction steps
- Feature request template with category and scope
- Configuration issue template for setup problems
- Template chooser config with links to docs and discussions

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Standardizes PR submissions with sections for summary, type of change,
testing checklist, and review requirements.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Configure automated dependency updates for:
- Main CLI package (weekly on Monday)
- Documentation site (weekly on Monday)
- GitHub Actions (weekly on Monday)

Groups TypeScript, testing, and linting dependencies together.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Assigns @rubenmarcus as code owner for all files, with explicit
ownership for core source, docs, CI/CD, and package configuration.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Test across Node.js 18, 20, and 22
- Add security audit job with npm audit
- Add CodeQL analysis for security scanning
- Use fail-fast: false for matrix to run all versions

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Documents the automated release workflow including:
- Feature PR to release PR flow
- Version bumping based on conventional commits
- npm publishing with appropriate tags
- Manual release instructions for emergencies
- Troubleshooting common issues

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages bot commented Jan 30, 2026

Deploying ralph-starter with  Cloudflare Pages  Cloudflare Pages

Latest commit: 453ba27
Status: ✅  Deploy successful!
Preview URL: https://8b405199.ralph-starter.pages.dev
Branch Preview URL: https://feat-oss-best-practices.ralph-starter.pages.dev

View logs

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@rubenmarcus rubenmarcus self-assigned this Jan 30, 2026
- Remove redundant docs job from ci.yml (already in docs-check.yml)
- Remove matrix testing (just use Node 20)
- Remove security audit and CodeQL jobs
- Add path filters: CI skips docs/md changes, docs-check only runs on docs changes

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@rubenmarcus rubenmarcus merged commit a0ed0d0 into main Jan 30, 2026
2 checks passed
rubenmarcus added a commit that referenced this pull request Jan 30, 2026
docs: add OSS best practices and community health files
rubenmarcus added a commit that referenced this pull request Jan 30, 2026
docs: add OSS best practices and community health files
@rubenmarcus rubenmarcus deleted the feat/oss-best-practices branch February 7, 2026 19:10
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.

1 participant