Adds "how we work" section across READMEs (#156)

* docs(README): adds "how we work" section * nit(README): reformulate warning * nit(README): change from warning to tip * docs(cli): adds "how we work" section in README * docs(base): adds "how we work" section in README * docs(connect): adds "how we work" section in README * docs(contractkit): adds "how we work" section in README * docs(cryptographic-utils): adds "how we work" section in README * docs(explorer): adds "how we work" section in README * docs(governance): adds "how we work" section in README * docs(keystores): adds "how we work" section in README * docs(network-utils): adds "how we work" section in README * docs(phone-utils): adds "how we work" section in README * docs(transaction-uri): adds "how we work" section in README * docs(utils): adds "how we work" section in README * docs(wallet-base): adds "how we work" section in README * docs(wallet-hsm): adds "how we work" section in README * docs(wallet-hsm-aws): adds "how we work" section in README * docs(wallet-hsm-azure): adds "how we work" section in README * docs(wallet-hsm-gcp): initializes new README with "how we work" section * docs(wallet-ledger): initializes new README with "how we work" section * docs(wallet-local): initializes new README with "how we work" section * docs(wallet-remote): initializes new README with "how we work" section * docs(wallet-rpc): initializes new README with "how we work" section * docs: adds auto-generated documentation
celo-org · Feb 27, 2024 · eeeba23 · eeeba23
1 parent ae51ca8
commit eeeba23
Show file tree

Hide file tree

Showing 26 changed files with 547 additions and 23 deletions.
diff --git a/README.md b/README.md
@@ -1,12 +1,31 @@
 # Developer Tooling
 
-> **NOTE** This is a relatively new repository and is still under active development.
-> Some of the packages and release processes may not be fully documented yet.
-
 This repository contains the source code for various JS/TS developer tools and CLI(s) released by cLabs 
 for the Celo community. 
 
-This includes: 
+## How we work
+
+We are a GitHub-first team, which means we have a strong preference for communicating via GitHub. 
+Please use GitHub to:
+
+🐞 [File a bug report](https://github.com/celo-org/developer-tooling/issues/new/choose)
+
+💬 [Ask a question](https://github.com/celo-org/developer-tooling/discussions)
+
+✨ [Suggest a feature](httpsi//github.com/celo-org/developer-tooling/issues/new/choose)
+
+🧑‍💻 [Contribute!](/CONTRIBUTING.md)
+
+🚔 [Report a security vulnerability](https://github.com/celo-org/developer-tooling/issues/new/choose)
+
+> [!TIP]
+> 
+> Please avoid messaging us via Slack, Telegram, or email. We are more likely to respond to you on 
+> GitHub than if you message us anywhere else. We actively monitor GitHub, and will get back to you shortly 🌟
+
+## Code
+
+This repository contains source code for: 
 
 - [`@celo/celocli`](https://www.npmjs.com/package/@celo/celocli)
 - [`@celo/base`](https://www.npmjs.com/package/@celo/base)
@@ -17,7 +36,7 @@ This includes:
 - [`@celo/governance`](https://www.npmjs.com/package/@celo/governance)
 - [`@celo/keystore`](https://www.npmjs.com/package/@celo/keystores)
 - [`@celo/network-utils`](https://www.npmjs.com/package/@celo/network-utils)
-- [`@celo/phone-utils`](https://www.npmjs.com/package/@celo/phone-utils) (may be deprecated soon ⚠️)
+- [`@celo/phone-utils`](https://www.npmjs.com/package/@celo/phone-utils)
 - [`@celo/transaction-uri`](https://www.npmjs.com/package/@celo/transactions-uri)
 - Wallet related packages including:
   - [`@celo/wallet-base`](https://www.npmjs.com/package/@celo/wallet-base)

diff --git a/packages/cli/README.md b/packages/cli/README.md
diff --git a/packages/docs/sdk/docs/connect/README.md b/packages/docs/sdk/docs/connect/README.md
@@ -4,6 +4,26 @@
 
 *Connect to the Celo Blockchain.*  `Connection` provides the core of what you need to interact with Celo blockchain. The Core Difference between it and ContractKit is that it provides zero Contract Wrappers, and therefore leaves out convenience methods for example for setting FeeCurrency, or getting configs.
 
+## How we work
+
+We are a GitHub-first team, which means we have a strong preference for communicating via GitHub. 
+Please use GitHub to:
+
+🐞 [File a bug report](https://github.com/celo-org/developer-tooling/issues/new/choose)
+
+💬 [Ask a question](https://github.com/celo-org/developer-tooling/discussions)
+
+✨ [Suggest a feature](httpsi//github.com/celo-org/developer-tooling/issues/new/choose)
+
+🧑‍💻 [Contribute!](/CONTRIBUTING.md)
+
+🚔 [Report a security vulnerability](https://github.com/celo-org/developer-tooling/issues/new/choose)
+
+> [!TIP]
+> 
+> Please avoid messaging us via Slack, Telegram, or email. We are more likely to respond to you on 
+> GitHub than if you message us anywhere else. We actively monitor GitHub, and will get back to you shortly 🌟
+
 ## Examples
 
 ### Basic

diff --git a/packages/docs/sdk/docs/contractkit/README.md b/packages/docs/sdk/docs/contractkit/README.md
@@ -21,6 +21,26 @@ You might not need the full ContractKit. Consider using `@celo/connect` which po
 
 :::
 
+## How we work
+
+We are a GitHub-first team, which means we have a strong preference for communicating via GitHub. 
+Please use GitHub to:
+
+🐞 [File a bug report](https://github.com/celo-org/developer-tooling/issues/new/choose)
+
+💬 [Ask a question](https://github.com/celo-org/developer-tooling/discussions)
+
+✨ [Suggest a feature](httpsi//github.com/celo-org/developer-tooling/issues/new/choose)
+
+🧑‍💻 [Contribute!](/CONTRIBUTING.md)
+
+🚔 [Report a security vulnerability](https://github.com/celo-org/developer-tooling/issues/new/choose)
+
+> [!TIP]
+> 
+> Please avoid messaging us via Slack, Telegram, or email. We are more likely to respond to you on 
+> GitHub than if you message us anywhere else. We actively monitor GitHub, and will get back to you shortly 🌟
+
 ### Getting Started
 
 To install:

diff --git a/packages/docs/sdk/docs/cryptographic-utils/README.md b/packages/docs/sdk/docs/cryptographic-utils/README.md
@@ -7,3 +7,23 @@ Here you can find cryptographic functions for
 * Celo mnemonics
 * BLS
 * encrypting/decrypting messages sent in transfers like Valora does
+
+## How we work
+
+We are a GitHub-first team, which means we have a strong preference for communicating via GitHub. 
+Please use GitHub to:
+
+🐞 [File a bug report](https://github.com/celo-org/developer-tooling/issues/new/choose)
+
+💬 [Ask a question](https://github.com/celo-org/developer-tooling/discussions)
+
+✨ [Suggest a feature](httpsi//github.com/celo-org/developer-tooling/issues/new/choose)
+
+🧑‍💻 [Contribute!](/CONTRIBUTING.md)
+
+🚔 [Report a security vulnerability](https://github.com/celo-org/developer-tooling/issues/new/choose)
+
+> [!TIP]
+> 
+> Please avoid messaging us via Slack, Telegram, or email. We are more likely to respond to you on 
+> GitHub than if you message us anywhere else. We actively monitor GitHub, and will get back to you shortly 🌟
diff --git a/packages/docs/sdk/docs/phone-utils/README.md b/packages/docs/sdk/docs/phone-utils/README.md
@@ -2,6 +2,28 @@
 
 # @celo/phone-utils
 
-These are A collection of functions for formatting and reading phonenumbers used by the v1 Attestation Service and wallets such as Valora. It uses `google-lib-phonenumber`,  under the hood.
+These are a collection of functions for formatting and reading phone numbers used by the 
+validator-run attestation service and (formerly) wallets such as Valora. 
+It uses `google-lib-phonenumber`, under the hood.
 
 It may be deprecated in the future.
+
+## How we work
+
+We are a GitHub-first team, which means we have a strong preference for communicating via GitHub. 
+Please use GitHub to:
+
+🐞 [File a bug report](https://github.com/celo-org/developer-tooling/issues/new/choose)
+
+💬 [Ask a question](https://github.com/celo-org/developer-tooling/discussions)
+
+✨ [Suggest a feature](httpsi//github.com/celo-org/developer-tooling/issues/new/choose)
+
+🧑‍💻 [Contribute!](/CONTRIBUTING.md)
+
+🚔 [Report a security vulnerability](https://github.com/celo-org/developer-tooling/issues/new/choose)
+
+> [!TIP]
+> 
+> Please avoid messaging us via Slack, Telegram, or email. We are more likely to respond to you on 
+> GitHub than if you message us anywhere else. We actively monitor GitHub, and will get back to you shortly 🌟
diff --git a/packages/sdk/base/README.MD b/packages/sdk/base/README.MD
@@ -3,6 +3,25 @@
 
 This package contains shared classes and functions used by other celo packages. It was designed to have minimal external dependencies. (for shared celo functions that have big external dependencies see the @celo/utils, @celo/cryptographic-utils, @celo/phone-utils, @celo/network-utils packages)
 
+## How we work
+
+We are a GitHub-first team, which means we have a strong preference for communicating via GitHub. 
+Please use GitHub to:
+
+🐞 [File a bug report](https://github.com/celo-org/developer-tooling/issues/new/choose)
+
+💬 [Ask a question](https://github.com/celo-org/developer-tooling/discussions)
+
+✨ [Suggest a feature](httpsi//github.com/celo-org/developer-tooling/issues/new/choose)
+
+🧑‍💻 [Contribute!](/CONTRIBUTING.md)
+
+🚔 [Report a security vulnerability](https://github.com/celo-org/developer-tooling/issues/new/choose)
+
+> [!TIP]
+> 
+> Please avoid messaging us via Slack, Telegram, or email. We are more likely to respond to you on 
+> GitHub than if you message us anywhere else. We actively monitor GitHub, and will get back to you shortly 🌟
 
 ## Notable Types
 

diff --git a/packages/sdk/connect/README.md b/packages/sdk/connect/README.md
@@ -1,8 +1,27 @@
 # @celo/connect
 
-
 *Connect to the Celo Blockchain.*  `Connection` provides the core of what you need to interact with Celo blockchain. The Core Difference between it and ContractKit is that it provides zero Contract Wrappers, and therefore leaves out convenience methods for example for setting FeeCurrency, or getting configs.
 
+## How we work
+
+We are a GitHub-first team, which means we have a strong preference for communicating via GitHub. 
+Please use GitHub to:
+
+🐞 [File a bug report](https://github.com/celo-org/developer-tooling/issues/new/choose)
+
+💬 [Ask a question](https://github.com/celo-org/developer-tooling/discussions)
+
+✨ [Suggest a feature](httpsi//github.com/celo-org/developer-tooling/issues/new/choose)
+
+🧑‍💻 [Contribute!](/CONTRIBUTING.md)
+
+🚔 [Report a security vulnerability](https://github.com/celo-org/developer-tooling/issues/new/choose)
+
+> [!TIP]
+> 
+> Please avoid messaging us via Slack, Telegram, or email. We are more likely to respond to you on 
+> GitHub than if you message us anywhere else. We actively monitor GitHub, and will get back to you shortly 🌟
+
 ## Examples
 
 ### Basic

diff --git a/packages/sdk/contractkit/README.md b/packages/sdk/contractkit/README.md
@@ -19,6 +19,26 @@ You might not need the full ContractKit. Consider using `@celo/connect` which po
 
 :::
 
+## How we work
+
+We are a GitHub-first team, which means we have a strong preference for communicating via GitHub. 
+Please use GitHub to:
+
+🐞 [File a bug report](https://github.com/celo-org/developer-tooling/issues/new/choose)
+
+💬 [Ask a question](https://github.com/celo-org/developer-tooling/discussions)
+
+✨ [Suggest a feature](httpsi//github.com/celo-org/developer-tooling/issues/new/choose)
+
+🧑‍💻 [Contribute!](/CONTRIBUTING.md)
+
+🚔 [Report a security vulnerability](https://github.com/celo-org/developer-tooling/issues/new/choose)
+
+> [!TIP]
+> 
+> Please avoid messaging us via Slack, Telegram, or email. We are more likely to respond to you on 
+> GitHub than if you message us anywhere else. We actively monitor GitHub, and will get back to you shortly 🌟
+
 ### Getting Started
 
 To install:

diff --git a/packages/sdk/cryptographic-utils/README.md b/packages/sdk/cryptographic-utils/README.md
@@ -5,3 +5,23 @@ Here you can find cryptographic functions for
 * Celo mnemonics
 * BLS
 * encrypting/decrypting messages sent in transfers like Valora does
+
+## How we work
+
+We are a GitHub-first team, which means we have a strong preference for communicating via GitHub. 
+Please use GitHub to:
+
+🐞 [File a bug report](https://github.com/celo-org/developer-tooling/issues/new/choose)
+
+💬 [Ask a question](https://github.com/celo-org/developer-tooling/discussions)
+
+✨ [Suggest a feature](httpsi//github.com/celo-org/developer-tooling/issues/new/choose)
+
+🧑‍💻 [Contribute!](/CONTRIBUTING.md)
+
+🚔 [Report a security vulnerability](https://github.com/celo-org/developer-tooling/issues/new/choose)
+
+> [!TIP]
+> 
+> Please avoid messaging us via Slack, Telegram, or email. We are more likely to respond to you on 
+> GitHub than if you message us anywhere else. We actively monitor GitHub, and will get back to you shortly 🌟
diff --git a/packages/sdk/explorer/README.md b/packages/sdk/explorer/README.md
@@ -1,5 +1,23 @@
-
-
 # @celo/explorer
 
 Explorer depends on contractkit and connect. It provides some utility functions that make it easy to listen for new block and log information.
+
+## How we work
+
+We are a GitHub-first team, which means we have a strong preference for communicating via GitHub. 
+Please use GitHub to:
+
+🐞 [File a bug report](https://github.com/celo-org/developer-tooling/issues/new/choose)
+
+💬 [Ask a question](https://github.com/celo-org/developer-tooling/discussions)
+
+✨ [Suggest a feature](httpsi//github.com/celo-org/developer-tooling/issues/new/choose)
+
+🧑‍💻 [Contribute!](/CONTRIBUTING.md)
+
+🚔 [Report a security vulnerability](https://github.com/celo-org/developer-tooling/issues/new/choose)
+
+> [!TIP]
+> 
+> Please avoid messaging us via Slack, Telegram, or email. We are more likely to respond to you on 
+> GitHub than if you message us anywhere else. We actively monitor GitHub, and will get back to you shortly 🌟
diff --git a/packages/sdk/governance/README.md b/packages/sdk/governance/README.md
@@ -6,3 +6,22 @@ It provides functions to read and interact with Celo Governance Proposals (CGPs)
 
 Construct Celo Governance Proposals using either the `InteractiveProposalBuilder` class (for CLI apps) or `ProposalBuilder` (consumable via JS)
 
+## How we work
+
+We are a GitHub-first team, which means we have a strong preference for communicating via GitHub. 
+Please use GitHub to:
+
+🐞 [File a bug report](https://github.com/celo-org/developer-tooling/issues/new/choose)
+
+💬 [Ask a question](https://github.com/celo-org/developer-tooling/discussions)
+
+✨ [Suggest a feature](httpsi//github.com/celo-org/developer-tooling/issues/new/choose)
+
+🧑‍💻 [Contribute!](/CONTRIBUTING.md)
+
+🚔 [Report a security vulnerability](https://github.com/celo-org/developer-tooling/issues/new/choose)
+
+> [!TIP]
+> 
+> Please avoid messaging us via Slack, Telegram, or email. We are more likely to respond to you on 
+> GitHub than if you message us anywhere else. We actively monitor GitHub, and will get back to you shortly 🌟
diff --git a/packages/sdk/keystores/README.md b/packages/sdk/keystores/README.md
@@ -1,3 +1,21 @@
+# @celo/keystores
 
+## How we work
 
-# @celo/keystores
+We are a GitHub-first team, which means we have a strong preference for communicating via GitHub. 
+Please use GitHub to:
+
+🐞 [File a bug report](https://github.com/celo-org/developer-tooling/issues/new/choose)
+
+💬 [Ask a question](https://github.com/celo-org/developer-tooling/discussions)
+
+✨ [Suggest a feature](httpsi//github.com/celo-org/developer-tooling/issues/new/choose)
+
+🧑‍💻 [Contribute!](/CONTRIBUTING.md)
+
+🚔 [Report a security vulnerability](https://github.com/celo-org/developer-tooling/issues/new/choose)
+
+> [!TIP]
+> 
+> Please avoid messaging us via Slack, Telegram, or email. We are more likely to respond to you on 
+> GitHub than if you message us anywhere else. We actively monitor GitHub, and will get back to you shortly 🌟
diff --git a/packages/sdk/network-utils/README.md b/packages/sdk/network-utils/README.md
@@ -1,4 +1,23 @@
-
 # @celo/network-utils
 
  @celo/network-utils provides utilities for getting genesis block and static node information.
+
+## How we work
+
+We are a GitHub-first team, which means we have a strong preference for communicating via GitHub. 
+Please use GitHub to:
+
+🐞 [File a bug report](https://github.com/celo-org/developer-tooling/issues/new/choose)
+
+💬 [Ask a question](https://github.com/celo-org/developer-tooling/discussions)
+
+✨ [Suggest a feature](httpsi//github.com/celo-org/developer-tooling/issues/new/choose)
+
+🧑‍💻 [Contribute!](/CONTRIBUTING.md)
+
+🚔 [Report a security vulnerability](https://github.com/celo-org/developer-tooling/issues/new/choose)
+
+> [!TIP]
+> 
+> Please avoid messaging us via Slack, Telegram, or email. We are more likely to respond to you on 
+> GitHub than if you message us anywhere else. We actively monitor GitHub, and will get back to you shortly 🌟