Skip to content

doc(contributing): add contributing guidelines and security policy#26

Merged
jfrosorio merged 2 commits into
mainfrom
doc-25
Jul 14, 2026
Merged

doc(contributing): add contributing guidelines and security policy#26
jfrosorio merged 2 commits into
mainfrom
doc-25

Conversation

@jfrosorio

@jfrosorio jfrosorio commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

Closes #25

  • CONTRIBUTING.md: branch targeting (main for features, v2 for security fixes only, v1 EOL), dev setup, quality-suite commands, PR conventions
  • SECURITY.md: supported-versions table and private disclosure via GitHub Security Advisories with email fallback
  • README: renames Testing to "Testing & code quality" documenting the lint/analyse/format scripts from chore(quality): add Pint code style and PHPStan static analysis #24, and adds Contributing and Security sections linking the new docs

Rebased onto main after #20 and #24 merged, so the composer scripts referenced by the contributing guide exist on this branch.

@jfrosorio jfrosorio self-assigned this Jul 14, 2026
@jfrosorio jfrosorio added the documentation Improvements or additions to documentation label Jul 14, 2026
@jfrosorio
jfrosorio requested a review from Copilot July 14, 2026 22:18

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 adds repository meta-documentation to guide contributors and define the project’s security vulnerability disclosure process, addressing Issue #25.

Changes:

  • Adds CONTRIBUTING.md with branch-targeting guidance, local dev setup steps, and PR/bug-report conventions.
  • Adds SECURITY.md with a supported-versions table and private vulnerability reporting instructions.

Reviewed changes

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

File Description
CONTRIBUTING.md Introduces contribution workflow, branch targeting rules, and local commands/conventions for PRs and bug reports.
SECURITY.md Defines supported versions and establishes a private disclosure channel via GitHub Security Advisories (with email fallback).

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

Comment thread CONTRIBUTING.md
Comment thread CONTRIBUTING.md
@jfrosorio
jfrosorio merged commit dea5813 into main Jul 14, 2026
9 checks passed
@jfrosorio
jfrosorio deleted the doc-25 branch July 14, 2026 22:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add contributing guidelines and security policy

2 participants