Skip to content

docs: add security policy#2127

Open
iamdadmin wants to merge 3 commits into
tempestphp:3.xfrom
iamdadmin:3.x-security-policy
Open

docs: add security policy#2127
iamdadmin wants to merge 3 commits into
tempestphp:3.xfrom
iamdadmin:3.x-security-policy

Conversation

@iamdadmin
Copy link
Copy Markdown
Contributor

I offered to type this up in the Discord a while ago, Aidan said to go ahead, so now committing this for review.

It's just a light touch and from what I can see outwardly just covers off what you're already doing.

I drew guidance from the following:

If you'd like me to go into more detail or add anything else, I'm happy to work on it.

You may also need to manually link it in the "Security and quality" tab if it's not automatically detected.

In the initial commit I did suggest a security shared email address, but as GH has a private submission form which goes to core maintainers, I just updated to use that link.

Copy link
Copy Markdown
Member

@innocenzi innocenzi left a comment

Choose a reason for hiding this comment

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

Only a syntax review, I haven't checked the policy itself, will need @aidan-casey, @xHeaven and @brendt's review

Comment thread SECURITY.md Outdated
Comment thread SECURITY.md Outdated
Comment thread SECURITY.md Outdated
Comment thread SECURITY.md Outdated
Comment thread SECURITY.md Outdated
Comment thread SECURITY.md Outdated
Comment thread SECURITY.md Outdated
Comment thread SECURITY.md Outdated
Comment thread SECURITY.md Outdated
Comment thread SECURITY.md Outdated
@innocenzi innocenzi changed the title docs: add security.md docs: add security policy Apr 27, 2026
@iamdadmin
Copy link
Copy Markdown
Contributor Author

iamdadmin commented Apr 27, 2026

Only a syntax review, I haven't checked the policy itself

Obviously I can make all of those changes, but from a grammar standpoint;

  • Security Policy is a proper noun, it's a type of policy,
  • Security Issue is a proper noun, it is a type of issue,
  • Pull Request equally is a proper noun, it has a well-known GitHub definition
  • Multi-Factor Authentication is a proper noun, it refers to a specific technology which has a well-known definition,
  • Technically speaking Resolution Process is a proper noun as it is a type of process, but as I'm effectively defining it within the document, instead of it being a pre-existing definition, it could go either way.

So in this context, most of those should in fact be capitalised where used.

If you need the headings to follow the convention so only the first character is a capital, I can re-work it so it doesn't use the proper nouns, but the references within the paragraphs themselves should remain capitalised. Would that work? (And I can obviously do a commit changing TempestPHP to Tempest...)

@innocenzi
Copy link
Copy Markdown
Member

innocenzi commented Apr 27, 2026

Sorry, but you're incorrect. None of those are "proper nouns", they're actually common nouns, even those referring to very specific concepts.

Let's stick to sentence case to stay consistent with the current documentation and keep it easy to scan

Co-authored-by: Enzo Innocenzi <enzo@innocenzi.dev>
@github-actions
Copy link
Copy Markdown

This pull request is stale because it has been open for 30 days with no activity.

@github-actions github-actions Bot added the Stale This issue has seen no activity for a while label May 29, 2026
@github-actions
Copy link
Copy Markdown

This pull request was closed because it has been inactive for 1 day since being marked as stale.

@github-actions github-actions Bot closed this May 31, 2026
@innocenzi innocenzi reopened this May 31, 2026
@innocenzi innocenzi removed the Stale This issue has seen no activity for a while label May 31, 2026
Copy link
Copy Markdown
Member

@aidan-casey aidan-casey left a comment

Choose a reason for hiding this comment

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

Generally I think this looks good. Let's get these changes made and get it merged.

Comment thread SECURITY.md

## Reporting a security issue

If you think you have found a security issue within Tempest, don't create a GitHub issue and don't publish a pull request with proof of concept. In the first instance, report issues using [GitHub's security advisory reporting mechanism](https://github.com/tempestphp/tempest-framework/security/advisories/new), with as much information as you can provide, ideally including steps-to-recreate. Security reports submitted on this page are forwarded to the core maintainers only.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
If you think you have found a security issue within Tempest, don't create a GitHub issue and don't publish a pull request with proof of concept. In the first instance, report issues using [GitHub's security advisory reporting mechanism](https://github.com/tempestphp/tempest-framework/security/advisories/new), with as much information as you can provide, ideally including steps-to-recreate. Security reports submitted on this page are forwarded to the core maintainers only.
If you believe you have discovered a security issue in Tempest, please do not create a GitHub issue or publish a proof-of-concept pull request.
Instead, report the issue using [GitHub's security advisory reporting mechanism](https://github.com/tempestphp/tempest-framework/security/advisories/new) and provide as much detail as possible, including steps to reproduce the issue where applicable. Reports submitted through this process are visible only to the core maintainers.

Comment thread SECURITY.md

If you think you have found a security issue within Tempest, don't create a GitHub issue and don't publish a pull request with proof of concept. In the first instance, report issues using [GitHub's security advisory reporting mechanism](https://github.com/tempestphp/tempest-framework/security/advisories/new), with as much information as you can provide, ideally including steps-to-recreate. Security reports submitted on this page are forwarded to the core maintainers only.

The core maintainers will determine whether this is classified as a security issue, and address it accordingly, or whether it is classified as a regular bug, and may ask you to raise a GitHub issue instead, at this time.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
The core maintainers will determine whether this is classified as a security issue, and address it accordingly, or whether it is classified as a regular bug, and may ask you to raise a GitHub issue instead, at this time.
The core maintainers will determine whether this is classified as a security issue, and address it accordingly, or whether it is classified as a regular bug, and may ask you to raise a GitHub issue instead.

Comment thread SECURITY.md

## Resolution process

The core maintainers will aim to acknowledge and validate any reported security issue promptly.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
The core maintainers will aim to acknowledge and validate any reported security issue promptly.
The core maintainers will acknowledge and validate reported security issues as promptly as possible.

Comment thread SECURITY.md

The core maintainers will aim to acknowledge and validate any reported security issue promptly.

Following the validation of a security issue, the core maintainers will broadly:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
Following the validation of a security issue, the core maintainers will broadly:
Following the validation of a security issue, the core maintainers will:

Comment thread SECURITY.md

3. Consider offering a Rector automated fix within the release, where appropriate.

4. Notify all subscribed Tempest parties via the usual channels (discord, blog, etc) that the updated is published.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
4. Notify all subscribed Tempest parties via the usual channels (discord, blog, etc) that the updated is published.
4. Notify all subscribed Tempest parties via the usual channels (Discord, blog, etc) that the updated is published.

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.

3 participants