Skip to content

Commit

Permalink
reorganizes accept vs ignore lists for polkadot vocab to make it more…
Browse files Browse the repository at this point in the history
… effective (#15)
  • Loading branch information
dawnkelly09 authored Sep 20, 2024
1 parent c80256e commit 8a5b878
Show file tree
Hide file tree
Showing 12 changed files with 59 additions and 14 deletions.
3 changes: 3 additions & 0 deletions .github/styles/Papermoon/Acronyms.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ exceptions:
- CSS
- CSV
- DEBUG
- DNS
- DOM
- DPI
- EVM
Expand Down Expand Up @@ -47,6 +48,7 @@ exceptions:
- RPC
- RPM
- RSA
- SCALE
- SCM
- SCSS
- SDK
Expand All @@ -63,6 +65,7 @@ exceptions:
- URL
- USB
- UTF
- WSS
- XCM
- XML
- XSS
Expand Down
3 changes: 3 additions & 0 deletions .github/styles/Papermoon/CustomDictionary.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,7 @@ ignore:
# Reference file location relative to styles/config/ignore directory
# custom dictionary of cyrpto brands and token names/symbols
- brand-token-ignore.txt
# case insensitive list of polkadot related words
- polkadot-ignore.txt


2 changes: 1 addition & 1 deletion .github/styles/Papermoon/NotContractions.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
extends: substitution
message: "Use '%s' instead of '%s'."
message: "Use '%s' instead of '%s' to improve clarity for the reader"
link: 'https://developers.google.com/style/contractions'
level: suggestion
ignorecase: true
Expand Down
5 changes: 5 additions & 0 deletions .github/styles/Papermoon/WordSwapList.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,21 @@ swap:
a\.k\.a|aka: or|also known as
approx\.: approximately
check box: checkbox
config: configuration
disabled?: turn off|off|deactivate
file name: filename
HTTPs: HTTPS
in order to: to
Nginx: nginx|NGINX
open-source: open source
"(?:Polkadot JS|Polkadot.Js|Polkadot.JS)": Polkadot.js
"(?:repo|repos)": repository|repositories
rpc: RPC
stylesheet: style sheet
tablename: table name
url: URL
vs\.: versus
whitelist: allowlist
wasm: Wasm


10 changes: 5 additions & 5 deletions .github/styles/config/Papermoon.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
name: Papermoon
description: "Custom style guide for enforcing Papermoon standards."
name: PaperMoon
description: "Custom style guide for enforcing PaperMoon standards."
version: 0.1.0
rules:

### ALERT Level = Error (commit will fail) ###
### ALERT Level = Error ###

# Extends Vale dictionary to reference ignore files for customization
CustomDictionary: error
Expand All @@ -13,13 +13,13 @@ rules:
Titlecase.yml: error


### ALERT Level = Warning (commit will succeed) ###
### ALERT Level = Warning ###

# Enforces custom version of Google.WordList
WordSwapList.yml: warning


### ALERT Level = Suggestion (commit will succeed) ###
### ALERT Level = Suggestion ###

# Prompts user to spell out unfamiliar acronyms first time they are used
# Includes exception list to specify acronyms this rule will ignore
Expand Down
3 changes: 3 additions & 0 deletions .github/styles/config/ignore/brand-token-ignore.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Astar
Celo
CELO
Ethereum
ETH
Grafana
Klaytn
Kujira
Expand All @@ -15,6 +16,8 @@ Moonbeam
Moonriver
Moonbase Alpha
Polkadot
Rococo
ROC
Sei
Solana
Uniswap
Expand Down
26 changes: 26 additions & 0 deletions .github/styles/config/ignore/polkadot-ignore.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
args
backchannel
blockHash
bootnode
bootnodes
composable
coretime
dispatchable
extrinsics
forkless
inherents
invulnerables
liveness
multilocation
omninode
parachain
parachain's
parachains
parathread
relay chain
relay chains
runtimes
Smoldot
solochain
subxt
sudo
12 changes: 10 additions & 2 deletions .github/styles/config/vocabularies/Industry/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,29 +14,34 @@ Etherscan
EVM
EVMs
Ethereum
hardcoded
href
Injective
JavaScript
JSON-RPC
keystore
keystores
[Kk]eystore
[Kk]eystores
Merkle
mintable
multisig
namespace
namespaces
Nano
[Nn]ominable
nginx
npm
npx
onboarded
onboarding
permissionless
picosecond
Podman
Prometheus
[Pp]rometheus
promtool
Protobuf
proxied
proxying
runbooks
SDK
snake_case
Expand All @@ -51,8 +56,11 @@ UI
UIs
[Vv]alidator
[Vv]alidators
virtualhost
Wasm
webRTC
[Ww]ebsocket
[Ww]ebsockets



1 change: 1 addition & 0 deletions .github/styles/config/vocabularies/Papermoon/accept.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
MainNet
PaperMoon
TestNet
time frame

Expand Down
3 changes: 0 additions & 3 deletions .github/styles/config/vocabularies/Papermoon/reject.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,7 @@ her
hers
him
his
let's
our
she
we



Expand Down
4 changes: 1 addition & 3 deletions .github/styles/config/vocabularies/Polkadot/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@ dev_newBlock
dev_setHead
dev_setStorage
dev_timeTravel
[Dd]ispatchable
[Ee]xtrinsics
Ferdie
[Ff]orkless
FRAME
Expand Down Expand Up @@ -52,6 +50,7 @@ Polkadot
Polkadot OpenGov
Polkadot's
Polkadot SDK
Polkassembly
[Rr]ebond
referenda
[Pr]eimage
Expand All @@ -60,7 +59,6 @@ referenda
relay chain
relay chains
Rococo
[Rr]untimes
Shiden
Smoldot
Snowbridge
Expand Down
1 change: 1 addition & 0 deletions polkadot-docs
Submodule polkadot-docs added at 929666

0 comments on commit 8a5b878

Please sign in to comment.