diff --git a/.github/docs/conventions.md b/.github/docs/conventions.md index a28882d7f..82311cb28 100644 --- a/.github/docs/conventions.md +++ b/.github/docs/conventions.md @@ -35,7 +35,7 @@ You should discuss larger changes and feature requests with the maintainers. Ple [Run CI e2e tests](/.github/docs/README.md) -# Code conventions +# Go code conventions ## General @@ -101,3 +101,8 @@ IP addresses: * key: symmetric key * pubKey: public key * privKey: private key + +# Shell script code conventions + +We use [shellcheck](https://github.com/koalaman/shellcheck) to ensure code quality. +You might want to install an [IDE extension](https://marketplace.visualstudio.com/items?itemName=timonwong.shellcheck). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 65ef404d2..6a658311f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,7 +13,9 @@ If you want to support our development: Constellation is licensed under the [AGPLv3](LICENSE). When contributing, you also need to agree to our [Contributor License Agreement](https://cla-assistant.io/edgelesssys/constellation). # Developer docs + We have some documentation, guidelines and conventions that you can go through to familiarize yourself with the project and get started hacking on it. + * Building, testing, deploying: [local development](/.github/docs/development.md) * [Code conventions](/.github/docs/conventions.md#code-conventions) * [Process conventions](/.github/docs/conventions.md#process-conventions)