docs: create a security policy (#2410)

* docs: create a security policy * docs: appropriately link security policy * docs: update security policy Co-authored-by: Anderson Arboleya <[email protected]> * docs: remove unnecessary line Co-authored-by: Peter Smith <[email protected]> * docs: remove unnecessary line break Co-authored-by: Anderson Arboleya <[email protected]> * docs: grammatical fix Co-authored-by: Anderson Arboleya <[email protected]> * docs: remove line break Co-authored-by: Anderson Arboleya <[email protected]> * docs: update guidelines Co-authored-by: Anderson Arboleya <[email protected]> * docs: update sentence structure Co-authored-by: Anderson Arboleya <[email protected]> * docs: remove unrelated section * docs: update SECURITY.md Co-authored-by: Anderson Arboleya <[email protected]> --------- Co-authored-by: Anderson Arboleya <[email protected]> Co-authored-by: Peter Smith <[email protected]>
FuelLabs · Jun 6, 2024 · e49b33f · e49b33f
1 parent b1dbe42
commit e49b33f
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -16,6 +16,8 @@ Check out our [Help Wanted](https://github.com/FuelLabs/fuels-ts/issues?q=is%3Ao
 
 If you are planning something big, for example, changes related to multiple components or changes to current behaviors, make sure to [open an issue](https://github.com/FuelLabs/fuels-ts/issues/new) to discuss with us before starting on the implementation.
 
+If you find a vulnerability or suspect it may be a security issue, please read our [Security Policy](./SECURITY.md) and follow the instructions.
+
 # Setting up
 
 ```sh

diff --git a/SECURITY.md b/SECURITY.md
@@ -0,0 +1,15 @@
+# Security Policy
+
+The Fuel Typescript SDK is still in development, and we take security very seriously.
+
+## Security Issues
+
+If you find a vulnerability or exploit, please report it immediately and privately:
+ - https://github.com/FuelLabs/fuels-ts/security/advisories/new
+
+      > Please **DO NOT** file a public issue.
+
+## Non-Security Issues
+
+If the issue is not security-related, please report it publicly:
+ - https://github.com/FuelLabs/fuels-ts/issues/new
-Original file line number
+Diff line change
@@ Expand Up @@
     If you are planning something big, for example, changes related to multiple components or changes to current behaviors, make sure to [open an issue](https://github.com/FuelLabs/fuels-ts/issues/new) to discuss with us before starting on the implementation.
+    If you find a vulnerability or suspect it may be a security issue, please read our [Security Policy](./SECURITY.md) and follow the instructions.
     # Setting up
     ```sh
@@ Expand Down @@