Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add security email info to readme #4298

Merged
merged 1 commit into from
May 1, 2024
Merged

Conversation

conorsch
Copy link
Contributor

@conorsch conorsch commented May 1, 2024

Describe your changes

We have an email alias set up for team leads, so that external parties have a single entrypoint to disclose security-related issues. Once we settle on language here, we can duplicate this notice in other Penumbra-related repositories.

Issue ticket number and link

Checklist before requesting a review

  • If this code contains consensus-breaking changes, I have added the "consensus-breaking" label. Otherwise, I declare my belief that there are not consensus-breaking changes, for the following reason:

    docs-only

We have an email alias set up for team leads, so that external parties
have a single entrypoint to disclose security-related issues.
Once we settle on language here, we can duplicate this notice in other
Penumbra-related repositories.
@conorsch conorsch requested a review from aubrika May 1, 2024 17:35
@cratelyn cratelyn added the A-docs Area: Documentation needs for the project label May 1, 2024
@cratelyn cratelyn added this to the Sprint 5 milestone May 1, 2024
Copy link
Contributor

@cratelyn cratelyn left a comment

Choose a reason for hiding this comment

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

✔️ this looks good, from a change perspective.

i'll let @aubrika own the formal approval, as this is a process change.

Copy link
Contributor

@aubrika aubrika left a comment

Choose a reason for hiding this comment

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

LGTM, this wording is clear & direct

@conorsch conorsch merged commit ba8c378 into main May 1, 2024
13 checks passed
@conorsch conorsch deleted the readme-security-disclosure branch May 1, 2024 19:38
conorsch added a commit to penumbra-zone/web that referenced this pull request Jun 5, 2024
We have an email alias set up for team leads, so that external parties
have a single entrypoint to disclose security-related issues.
This language matches what's already in the Penumbra monorepo, as of
[0].

[0] penumbra-zone/penumbra#4298
TalDerei added a commit to penumbra-zone/web that referenced this pull request Jun 8, 2024
* docs: add security email info to readme

We have an email alias set up for team leads, so that external parties
have a single entrypoint to disclose security-related issues.
This language matches what's already in the Penumbra monorepo, as of
[0].

[0] penumbra-zone/penumbra#4298

* format

---------

Co-authored-by: Conor Schaefer <[email protected]>
Co-authored-by: Tal Derei <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: Documentation needs for the project
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants