mirror/docker-mailserver.docker-mailserver
1
0
Fork 0
mirror of https://github.com/docker-mailserver/docker-mailserver.git synced 2025-07-25 13:14:56 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

chore(docs): outsourcing environment vars to the documentation (#1948)

Browse source 
Co-authored-by: Frederic Werner <20406381+wernerfred@users.noreply.github.com>
Co-authored-by: Casper <casperklein@users.noreply.github.com>
Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>
This commit is contained in:
Georg Lauterbach 2021-05-11 12:15:34 +02:00 • committed by GitHub
parent 29d630f695
commit 5449efd8d4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
18 changed files with 188 additions and 147 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/content/contributing/coding-style.md
View file

@ -2,7 +2,7 @@
title: 'Contributing | Coding Style'
---
##Bash and Shell
## Bash and Shell
When refactoring, writing or altering scripts, that is Shell and bash scripts, in any way, adhere to these rules:
@ -40,7 +40,7 @@ fi
### Variables & Braces
!!! attention
!!! attention
Variables are always uppercase. We always use braces.
@ -51,7 +51,7 @@ If you forgot this and want to change it later, you can use [this link][regex].
local VAR="good"
local NEW="${VAR}"
# bad -> TravisCI will fail
# bad -> CI will fail
var="bad"
new=$var
```

4
docs/content/contributing/issues-and-pull-requests.md
View file

@ -37,7 +37,7 @@ The development workflow is the following:
3. Add integration tests if necessary
4. Get the linters with `make install_linters` and install `jq` with the package manager of your OS
5. Use `make clean all` to build image locally and run tests (note that tests work on Linux **only**)
6. Document your improvements if necessary (e.g. if you introduced new environment variables, write the description in [`ENVIRONMENT.md`][github-file-env])
6. Document your improvements if necessary (e.g. if you introduced new environment variables, describe those in the [ENV documentation][docs-environment])
7. [Commit][commit] and [sign your commit][gpg], push and create a pull-request to merge into `master`. Please **use the pull-request template** to provide a minimum of contextual information and make sure to meet the requirements of the checklist.
1. Pull requests are automatically tested against the CI and will be reviewed when tests pass
2. When your changes are validated, your branch is merged
@ -45,6 +45,6 @@ The development workflow is the following:
[docs]: https://docker-mailserver.github.io/docker-mailserver/edge
[github-file-readme]: https://github.com/docker-mailserver/docker-mailserver/blob/master/README.md
[github-file-env]: https://github.com/docker-mailserver/docker-mailserver/blob/master/ENVIRONMENT.md
[docs-environment]: ../config/environment.md
[commit]: https://help.github.com/articles/closing-issues-via-commit-messages/
[gpg]: https://docs.github.com/en/github/authenticating-to-github/generating-a-new-gpg-key