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

feat(docs): add a SECURITY.md describing how to report vulnerabilities #848

Merged
merged 3 commits into from
Oct 1, 2024

Conversation

danceratopz
Copy link
Member

@danceratopz danceratopz commented Sep 30, 2024

πŸ—’οΈ Description

  • Add a SECURITY.md
  • Add short comments to the README and to the html landing page nudging people to the bounty program.
    image

πŸ”— Related Issues

None

βœ… Checklist

  • All: Set appropriate labels for the changes.
  • All: Considered squashing commits to improve commit history.
  • All: Added an entry to CHANGELOG.md. Skipped
  • All: Considered updating the online docs in the ./docs/ directory.
  • Tests: All converted JSON/YML tests from ethereum/tests have been added to converted-ethereum-tests.txt.
  • Tests: A PR with removal of converted JSON/YML tests from ethereum/tests have been opened.
  • Tests: Included the type and version of evm t8n tool used to locally execute test cases: e.g., ref with commit hash or geth 1.13.1-stable-3f40e65.
  • Tests: Ran mkdocs serve locally and verified the auto-generated docs for new tests in the Test Case Reference are correctly formatted.

@danceratopz danceratopz added scope:docs Scope: Documentation type:feat type: Feature labels Sep 30, 2024
Copy link
Member

@marioevz marioevz left a comment

Choose a reason for hiding this comment

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

Thanks for this, I think this is a good start to better inform people about security issues.

@danceratopz danceratopz merged commit c7dfb12 into main Oct 1, 2024
5 checks passed
@danceratopz danceratopz deleted the docs/add-security-md branch October 1, 2024 14:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope:docs Scope: Documentation type:feat type: Feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants