Git-Mirrors/constellation
1
0
Fork 0
mirror of https://github.com/edgelesssys/constellation.git synced 2025-08-03 12:36:09 -04:00
Code Issues Projects Releases Packages Wiki Activity

devdoc: update dev conventions

Browse source 
Signed-off-by: Paul Meyer <49727155+katexochen@users.noreply.github.com>
This commit is contained in:
Paul Meyer 2022-11-10 10:34:16 +01:00
parent 7aa7492474
commit 516477a46b
2 changed files with 8 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

7
.github/docs/conventions.md vendored
View file

@ -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).

2
CONTRIBUTING.md
View file

@ -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)