From bb800a518e14d7c237f1fc084560ed426c2772b8 Mon Sep 17 00:00:00 2001 From: Jessie Mongeon <133128541+jessiemongeon1@users.noreply.github.com> Date: Mon, 4 Dec 2023 10:30:09 -0600 Subject: [PATCH 1/2] Update style-guide.md --- style-guide.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/style-guide.md b/style-guide.md index 6005435ddc..d0196aa14e 100644 --- a/style-guide.md +++ b/style-guide.md @@ -260,11 +260,12 @@ The following language and capitalization of certain terms and phrases should be - Bitcoin integration - Bitcoin network: should be used in place of "sending bitcoin". - bitcoin: should be used when referring to BTC rather than the Bitcoin network. -- Built on the Internet Computer +- Built on ICP - canister - canister smart contract - dapp: should be used in place of any reference to an ICP app, decentralized application, or 'dApp'. - DeFi +- deployed on ICP - dfx or `dfx`: should be used in place of any reference to the dfx CLI tool; it may be formatted as in-line code or plain text as long as it is lowercase. - All dfx subcommands should be formatted as in-line code when appearing in a sentence, such as, "The `dfx deps` feature is available in dfx versions 0.14.1 and newer." - Ethereum integration @@ -272,15 +273,20 @@ The following language and capitalization of certain terms and phrases should be - HTTP outcalls - ICP: When abbreviating 'Internet Computer', it should be referred to as 'ICP' instead of 'IC' or 'the IC'. Two exceptions to this are: + - The IC SDK, which should be referred to as 'the IC SDK'. + - The IC interface specification, which should be referred to as 'the IC specification' or 'the IC interface specification'. + + When there may be a confusion between ICP referring to Internet Computer Protocol and ICP the token, the words 'Internet Computer Protocol' can be written out for clarity. + - IC SDK: should be used in place of any reference to the IC's SDK. - mainnet - In context: Deploying `to the mainnet` or `on the mainnet`. Note the use of the word `the`. - Other contextual usage: - - `The Internet Computer mainnet network.` + - `The ICP mainnet network.` - `The dapp has been deployed to the mainnet.` - - `Before deploying on to the Internet Computer mainnet...` + - `Before deploying on to the mainnet...` Additionally, mentions of the Bitcoin mainnet should use the same structure (prefaced with the word `the`.) - maturity - Motoko playground From 0fe70e894f2add1e68c5ad100a1891a3a0b7c70b Mon Sep 17 00:00:00 2001 From: Jessie Mongeon <133128541+jessiemongeon1@users.noreply.github.com> Date: Tue, 5 Dec 2023 16:09:17 -0600 Subject: [PATCH 2/2] Update style-guide.md --- style-guide.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/style-guide.md b/style-guide.md index d0196aa14e..80f549e750 100644 --- a/style-guide.md +++ b/style-guide.md @@ -260,7 +260,7 @@ The following language and capitalization of certain terms and phrases should be - Bitcoin integration - Bitcoin network: should be used in place of "sending bitcoin". - bitcoin: should be used when referring to BTC rather than the Bitcoin network. -- Built on ICP +- built on ICP - canister - canister smart contract - dapp: should be used in place of any reference to an ICP app, decentralized application, or 'dApp'. @@ -284,7 +284,6 @@ The following language and capitalization of certain terms and phrases should be - mainnet - In context: Deploying `to the mainnet` or `on the mainnet`. Note the use of the word `the`. - Other contextual usage: - - `The ICP mainnet network.` - `The dapp has been deployed to the mainnet.` - `Before deploying on to the mainnet...` Additionally, mentions of the Bitcoin mainnet should use the same structure (prefaced with the word `the`.)