STYLEGUIDE.md

Frequency Style Guide

Style guide defining wording, spelling, and other details regarding how Frequency terms are referenced.

For more information about Frequency, visit frequency.xyz or Frequency on GitHub

Activity Content Types

Uppercase A, C and T

Announcement

Uppercase A

Announcement Type

Uppercase A and T

Annual Rewards Rate

Uppercase A, R and R

Apache Parquet

Official

Avro Type

Uppercase A and T

batch

All lowercase

blockchain

As a general term, lowercase b

Boosting Ratio

Uppercase B and R

Capacity

Uppercase C

Capacity Allocation

Uppercase C and A

Capacity Economic System

Uppercase C, E and S (is this a thing?)

Capacity Epoch

Uppercase C and E

Capacity Staking

Uppercase C and S

Capacity Staking Model

Uppercase C, S and M

Capacity Staking Program

Uppercase C, S and P

Capacity Staking Ratio

Uppercase C, S and R

Capacity Token Rewards

DO NOT USE

Code of Conduct

Uppercase C, lowercase o, Uppercase C

coinless user

All lowercase

Collator

Uppercase C

Collator incentives

Do not use

Collator Nodes

Uppercase C and N

Collator Rewards

Uppercase C and R

community

All lowercase

content hash

All lowercase

Content Identifier (CID)

Official

contribution guidelines

All lowercase

Control Key

Uppercase C and K

cost per message

All lowercase

cost per transaction

All lowercase

dapp

All lowercase (per AP style and Etherium.org)

Data Transaction Model

Uppercase D, T and M

DeFi

Uppercase D and F single word (per AP style)

delegate

Used as a verb ONLY i.e. an MSA delegates to a Provider. Not as a noun.

delegation

Lowercase d

Delegation Model

Uppercase D and M

development community

All lowercase

DSNP public social graph

All lowercase after acronym

end user

Uppercase E and U

Epoch

Always Capacity Epoch or Reward Epoch

Exclamation Marks

Should be avoided

existential deposit

All lowercase

extrinsics

Lowercase e

Field Names

In Frequency use Camel Caps i.e. contentHash

Frequency

Uppercase F

Frequency Application

Uppercase F and A

Frequency Collator Nodes

Uppercase F, C and N

Frequency Council

Uppercase F and C

Frequency Message

Uppercase F and M

Frequency Network Foundation

Uppercase F, N and F

Frequency Nodes

Uppercase F and N

FRQCY

NEVER followed with the word token

Functions

In Frequency use Snake Case e.g. on_initialize

generated Capacity

Lowercase g and uppercase C

Governance/governance

Lowercase general, uppercase specific (Frequency Governance)

Graph Change Announcements

Remove, no longer relevant

Graph Change event

Remove, no longer relevant

graph edges

All lowercase

graph keys

All lowercase

Graph SDK

Uppercase G, S, D and K

graph types

All lowercase

Handle Display

Uppercase H and D

Interesting, Interesting to note

Filler words should be avoided

Initial Token Distribution

Uppercase I, T and D

internet

All lowercase (per AP Style)

InterPlanetary File System (IPFS)

Uppercase I, P, F and S. In the first instance, spell out followed by the acronym in parentheses. Use the acronym only thereafter.

key pair

All lowercase, two words

Layer 1, Layer 2

Uppercase L (space) numeral

Mainnet

Uppercase M

Maximum Capacity Staking

Uppercase M, C and S (is this term in use any more?)

mempool

Lowercase m

Message

Uppercase M

Message Batch

Uppercase M and B

Message Payload

Uppercase M and P

Message Source Account (MSA)

Uppercase M, S and A. In the first instance, spell out followed by the acronym in parentheses. Use the acronym only thereafter. Never MSA Account.

MSA Id

Uppercase M,S, A and I

MUST/MUST NOT

All caps when defining rules in a specification per W3 standard

node operator

All lowercase

Nominated Proof-of-Stake algorithm

official

On chain vs. on-chain

As an adjective prior to a noun, use a hyphen (e.g. on-chain storage) As a noun, no hyphen (e.g. stored on chain)

owning user

All lowercase

Oxford Comma

Always use

Page Id

Uppercase P and I

parachain

All lowercase

parameters

In Frequency use snake case e.g. current_block_number

Parquet

Uppercase P

Parquet Schema

Uppercase P and S

payload

All lowercase

Payload Location

Uppercase P and L

Polkadot

Uppercase P

Polkadot accounts

Uppercase P lowercase a

Polkadot protocol

Uppercase P, lowercase p

Polkadot Relay Chain

Polkadot wiki uses uppercase R and C

Possessives

Making Frequency possessive (e.g. Frequency’s) should be avoided

private connections

All lowercase

private follow

All lowercase

private graph

All lowercase

protocol

As general term, all lowercase

Provider

Uppercase P

Provider applications

Uppercase P and lowercase a

Provider Boosting

Uppercase P and B

Provider Capacity Allocation

Uppercase P, C, and A

Provider incentives

Uppercase P and lowercase i

Provider Platforms

Avoid using the word "platform"

Pseudonymous Relationship Identifiers (PRIds)

Uppercase, P, R and I (acronym lowercase d and s)

Public Collators

Uppercase P and C

public follow

All lowercase

public graph

All lowercase

public key

All lowercase

Reaction Announcement

Uppercase R and A

Reward/reward

Lowercase general, uppercase specific (Staking Reward)

Reward Epoch

Uppercase R and E

roadmap

All lowercase

runtime

Should be the Frequency Runtime

Schema

Uppercase S for specific (Frequency Schema) otherwise lowercase

Schema Models

Uppercase S and M

Schema Registry

Uppercase S and R

Schema Id

Uppercase S and I

session key

All lowercase

Signature Required setting

Uppercase S and R, lowercase s

Social Graph

Uppercase S and G

Social Web

Uppercase S and W

staking ratio

All lowercase unless preceded by "Capacity"

Stateful Storage

Uppercase S and S (no dash)

Substrate

Uppercase S

Team

Forbidden Term in context with Frequency

Technical Committee

Uppercase T and C

Testnet

Uppercase T

Thaw Period

Uppercase T and P

The Decentralized Social Network Protocol (DSNP)

Begin with "The". In the first instance, spell out followed by the acronym in parentheses. Use the acronym only thereafter.

the Project Liberty Code of Conduct

Uppercase P, L, C and C

token

Always lowercase, never used with FRQCY

Token Account

Uppercase T and A

Token Staking

Uppercase T and S

Token to Capacity Ratio

Uppercase T, lowercase t, Uppercase C and R

transaction fees

All lowercase

Types

In Frequency use Pascal Case (e.g. DoubleStorageMap)

Update Announcement

Uppercase U and A

User/user

Lowercase unless specific (Frequency User)

User Handle

Uppercase U and H

User Handle Base

Uppercase U, H and B

User Handle Suffix

Uppercase U, H and S

User Incentives

Uppercase U and I

User Interface or UI

Uppercase U and I

UTF-8

official

Wasm

official

Web 2.0

Uppercase W space between b and 2 Not Web2

web3

All lowercase one word (per AP style)

We/Us/Our

Forbidden Term in context with Frequency

XRQCY

All uppercase. NEVER have the word "token" after it.