From 0d1bbbe156cf63e19fcaacae500aa2d6608eef4c Mon Sep 17 00:00:00 2001 From: Ryan Butler Date: Fri, 11 Oct 2024 17:04:41 -0400 Subject: [PATCH] added md files --- CODE_OF_CONDUCT.md | 5 +++++ README.md | 9 +++++++++ SECURITY.md | 6 ++++++ 3 files changed, 20 insertions(+) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 SECURITY.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..3ac5458 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,5 @@ +# Code of Conduct + +Our code of conduct is located in the [orb-software repo][CODE_OF_CONDUCT]. + +[CODE_OF_CONDUCT]: https://github.com/worldcoin/orb-software/blob/main/CODE_OF_CONDUCT.md diff --git a/README.md b/README.md index d0f9a89..72c3dfa 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,15 @@ We generate blinding factors by taking as input a random seed of 32 bytes (e.g., ## Public Generator Setup We sample the generators for the Pedersen commitment deterministically using the Shake256 hash function which uses a public string as an initializer. This can be found under the `sample_generators` function in `./src/pedersen/mod.rs`. The public string (once used, this _must_ be fixed) can be found as the constant `PUBLIC_STRING` within `src/iriscode_commit/mod.rs`. +## Contributing + +We plan to accept contributions at a later date, but do not have +bandwidth to review PRs currently. + +Likewise, we are providing this source code for the benefit of the community, +but cannot commit to any SemVer or API stability guarantees. Be warned: we may +change things in a backwards-incompatible way at any time! + ## License Unless otherwise specified, all code in this repository is dual-licensed under either: diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..e5fe58f --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,6 @@ +# Security @ Worldcoin + +For reporting security vulnerabilities and our responsible disclosure policy, please +see the [orb-software repo][orb-software]. + +[orb-software]: https://github.com/worldcoin/orb-software/blob/main/SECURITY.md