mirror of
https://github.com/0rangebananaspy/authelia.git
synced 2024-09-14 22:47:21 +07:00
08e674b62f
Updated all links to use https://www.authelia.com/docs/. Removed all comment sections from documented configuration on the documentation site and replaced them with their own sections. Made all documentation inside config.template.yml double hashes, and made all commented configuration sections single quoted. Added .yamllint.yaml to express our desired YAML styles. Added a style guide. Refactored many documentation areas to be 120 char widths where possible. It's by no means exhaustive but is a large start. Added a statelessness guide for the pending Kubernetes chart introduction. Added labels to configuration documentation and made many areas uniform.
44 lines
1.6 KiB
Markdown
44 lines
1.6 KiB
Markdown
---
|
|
layout: default
|
|
title: Style Guide
|
|
parent: Contributing
|
|
nav_order: 4
|
|
---
|
|
|
|
# Style Guide
|
|
|
|
This is a general guide to the code style we aim to abide by. This is by no means an exhaustive list and we're
|
|
constantly changing and improving it. This is also a work in progress document.
|
|
|
|
For our commit messages please see our [Commit Message Guidelines](./commitmsg-guidelines.md).
|
|
|
|
## Tools
|
|
|
|
We implement the following tools that help us abide by our style guide and include the configuration for them inside
|
|
our repository:
|
|
- [golangci-lint](https://github.com/golangci/golangci-lint)
|
|
- [yamllint](https://yamllint.readthedocs.io/en/stable/)
|
|
- [eslint](https://eslint.org/)
|
|
- [prettier](https://prettier.io/)
|
|
|
|
## Exceptions
|
|
|
|
This is a style **guide** not a cudgel, there are always going to be exceptions to these guidelines when it makes sense
|
|
not to follow them. One notable exception is the README.md for the repository. The line length of the
|
|
[All Contributors](https://allcontributors.org/) individual sections are longer than 120 characters and it doesn't make
|
|
sense to apply the [line length](#line-length) guidelines.
|
|
|
|
## Specific Guidelines
|
|
|
|
### Line Length
|
|
|
|
We aim to keep all files to a maximum line length of 120 characters. This allows for most modern computer systems to
|
|
display two files side by side (vertically split). As always, keep in mind you should not restrict your line length
|
|
when it doesn't make sense to.
|
|
|
|
This includes but is not limited to the following file types:
|
|
- Go (*.go)
|
|
- YAML (*.yml, *.yaml)
|
|
- Markdown (*.md)
|
|
- JavaScript (*.js)
|
|
- TypeScript (*.ts, *.tsx) |