Skip to content

Commit 64b60b2

Browse files
fixes #56 - "We do not agree with all standards"
1 parent e6e674b commit 64b60b2

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

docs/1-introduction/introduction.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,5 +64,24 @@ Implementing formatting and coding standards has the following advantages for PL
6464
* The code is more efficient concerning performance and organization of the whole application.
6565
* The code is more modular and thus easier to use for other applications.
6666

67+
### We have other standards
68+
6769
This document only defines possible standards. These standards are not written in stone, but are meant as guidelines. If standards already exist, and they are different from those in this document, it makes no sense to change them.
6870

71+
### We do not agree with all your standards
72+
73+
There are basically two types of standards.
74+
75+
1. Non-controversial
76+
77+
These standards make sense. There is no reason not to follow them. An example of this category is [G-2150](../4-language-usage/2-variables-and-types/1-general/g-2150): Avoid comparisons with NULL value, consider using IS [NOT] NULL.
78+
79+
2. Controversial
80+
81+
Almost every rule/guildeline falls into this category. An example of this category is [3 space indention](../3-coding-style/coding-style/#rules). - Why not 2 or 4 or even 8? Why not use tabs? You can argue in favor of all these options. In most cases it does not really matter which option you choose. Being consistent is more important. In this case it will make the code easier to read.
82+
83+
For very controversial rules, we have started to include the reasoning either as a footnote or directly in the text.
84+
85+
Usually it is not helpful to open an issue on GitHub to request to change a highly controversial rule such as the one mentioned. For example, use 2 spaces instead of 3 spaces for an indentation. This leads to a discussion where the people in favor of 4 spaces start to argument as well. There is no right or wrong here. You just have to agree on a standard.
86+
87+
More effective is to fork [this repository](https://github.com/Trivadis/plsql-and-sql-coding-guidelines) and amend the standards fit your needs/expectations.

0 commit comments

Comments
 (0)