docs(codestyle): add empty code style document (ChainSafe#1925)

timwu20 · Dec 6, 2021 · 32e63c5 · 32e63c5
1 parent b93152a
commit 32e63c5
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 1 deletion.
diff --git a/.github/CODE_STYLE.md b/.github/CODE_STYLE.md
@@ -0,0 +1,3 @@
+# Code style
+
+🚧 work in progress! 🚧
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -14,6 +14,8 @@ The [Polkadot Runtime Specification](https://research.web3.foundation/en/latest/
 
 One important distinction is that we are building the Polkadot Runtime Environment, not Polkadot itself. Given that, although a deep understanding of Polkadot is helpful, it's not critical to contribute to gossamer. To help understand how the Runtime Environment relates to Polkadot, check out this [talk that one of our team members gave at DotCon](https://www.youtube.com/watch?v=nYkbYhM5Yfk).
 
+For coding style, you may refer to the [code style](CODE_STYLE.md) document which we keep up to date with coding style conventions we have for this repository.
+
 ## Contribution Steps
 
 1. **Fork the gossamer repo.**

diff --git a/README.md b/README.md
@@ -128,7 +128,7 @@ To start the polkadot node:
 
 ## Contribute
 
-- Check out [Contributing Guidelines](.github/CONTRIBUTING.md)  
+- Check out [Contributing Guidelines](.github/CONTRIBUTING.md) and our [code style](.github/CODE_STYLE.md) document
 - Have questions? Say hi on [Discord](https://discord.gg/Xdc5xjE)!
 
 ## Donate