Skip to content

Commit

Permalink
Finish contributing.md and add security policy
Browse files Browse the repository at this point in the history
  • Loading branch information
aboutdavid committed May 21, 2024
1 parent b96774a commit 5296d75
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
12 changes: 12 additions & 0 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Security

Hack Club takes the security and privacy of Hack Clubbers very seriously, regardless of jurisdiction, as in, we believe everyone has the right to control their data

If you have any security concerns or would like to report security issues, please email toriel@hackclub.com. You should receive a response within 24 hours. If not, or if it is very urgent, you can [join our Slack](https://hackclub.com/slack) and mention that you found a security issue in Toriel.

Please provide as much information as you can, including:
- Commit version (`git rev-parse --short HEAD`) (if self-hosting)
- Step by step instructions on how to reproduce it
- Proof of concept (if possible)
- Impact/security risk of the issue

3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Before submitting a report, please make sure you checked and have done the follo

### Using it in Slack
- Included screenshots/screen recordings of the bug.
- Explain what you were doing right before the bug occured

### Self-Hosting
- Checked your Node.js version
Expand All @@ -25,7 +26,7 @@ Before submitting a report, please make sure you checked and have done the follo
- Included logs given by the bot.

## Security Issues
Please **do not submit security issues via GitHub issues**. Please notify the Toriel development team privately at <\insert email here\>
Please **do not submit security issues via GitHub issues**. This is because Toriel has access to very sensitive data, such as IP addresses, E-mails, and other personally identifiable information (PII). Please notify the Toriel development team privately at toriel@hackclub.com. Read more in our [security policy](https://github.com/hackclub/toriel/blob/main/.github/SECURITY.md)

## Setting up a development environment
There are [instructions in the README.md](https://github.com/hackclub/toriel#running-locally) on how to set it up.

0 comments on commit 5296d75

Please sign in to comment.