mirror of
https://github.com/edgelesssys/constellation.git
synced 2025-02-22 07:50:04 -05:00
devdoc: update dev conventions
Signed-off-by: Paul Meyer <49727155+katexochen@users.noreply.github.com>
This commit is contained in:
parent
7aa7492474
commit
516477a46b
7
.github/docs/conventions.md
vendored
7
.github/docs/conventions.md
vendored
@ -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).
|
||||
|
@ -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)
|
||||
|
Loading…
x
Reference in New Issue
Block a user