Blame: doc/coding_standards.md - apache/thrift

apache / thrift UNCLAIMED

Apache Thrift

0 0 0 C++

THRIFT-2724 - Coding standards template added all over project Client: All Patch: Konrad Grochowski This closes #371 2015-02-04 16:43:26 +01:00			`# Thrift Coding Standards`

			`Any fool can write code that a computer can understand.`
			`Good programmers write code that humans can understand.`
			`-- Martin Fowler, 1999`

			`The purpose of this document is to make everyone's life easier.`

Grammatical/Typo changes Patch: Pooja Chandak This closes #2271 2020-11-06 11:33:40 +01:00			`It's easier when you read good, well-formatted, with a clearly defined purpose, code.`
THRIFT-2724 - Coding standards template added all over project Client: All Patch: Konrad Grochowski This closes #371 2015-02-04 16:43:26 +01:00			`But the only way to read clean code is to write such.`

			`This document can help achieve that, but keep in mind that`
			`those are not silver-bullet, fix-all-at-once rules. Just think about readability while writing code.`
Grammatical/Typo changes Patch: Pooja Chandak This closes #2271 2020-11-06 11:33:40 +01:00			`Write code like you would have to read it ten years from now.`
THRIFT-2724 - Coding standards template added all over project Client: All Patch: Konrad Grochowski This closes #371 2015-02-04 16:43:26 +01:00
			`## General Coding Standards`

			`Thrift has some history. Not all existing code follows those rules.`
			`But we want to improve over time.`
Grammatical/Typo changes Patch: Pooja Chandak This closes #2271 2020-11-06 11:33:40 +01:00			`When making a small change / bugfix - like a single line fix - do not refactor the whole function.`
THRIFT-2724 - Coding standards template added all over project Client: All Patch: Konrad Grochowski This closes #371 2015-02-04 16:43:26 +01:00			`That disturbs code repository history.`
			`Whenever adding something new and / or making bigger refactoring`
			`- follow those rules as strictly as you can.`

			`When in doubt - contact other developers (using dev@ mailing list or IRC).`
			`Code review is the best way to improve readability.`

			`### Basics`
Grammatical/Typo changes Patch: Pooja Chandak This closes #2271 2020-11-06 11:33:40 +01:00			`* Use spaces, not tabs`
THRIFT-2724 - Coding standards template added all over project Client: All Patch: Konrad Grochowski This closes #371 2015-02-04 16:43:26 +01:00			`* Use only ASCII characters in file and directory names`
Grammatical/Typo changes Patch: Pooja Chandak This closes #2271 2020-11-06 11:33:40 +01:00			`* Commit to the repository using Unix-style line endings (LF)`
THRIFT-2724 - Coding standards template added all over project Client: All Patch: Konrad Grochowski This closes #371 2015-02-04 16:43:26 +01:00			`On Windows:`
			`git config core.autocrlf true`
			`* Maximum line width - 100 characters`
			`* If not specified otherwise in language specific standard - use 2 spaces as indent/tab`

			`### Comments`
Grammatical/Typo changes Patch: Pooja Chandak This closes #2271 2020-11-06 11:33:40 +01:00			`* Each file has to start with a comment containing [Apache License](http://www.apache.org/licenses/LICENSE-2.0)`
			`* Public API of a library should be documented, preferably using format native for language-specific documentation generation tools (Javadoc, Doxygen etc.)`
THRIFT-2724 - Coding standards template added all over project Client: All Patch: Konrad Grochowski This closes #371 2015-02-04 16:43:26 +01:00			`* Other comments are discouraged - comments are lies. When one has to make comment it means one failed to write readable code. Instead of "I should write a comment here" think "I should clean it up"`
			`* Do not leave "TODO/FIXME" comments - file [Jira](http://issues.apache.org/jira/browse/THRIFT) issue instead`

			`### Naming`
			`Finding proper names is the most important and most difficult task in software development.`

Grammatical/Typo changes Patch: Pooja Chandak This closes #2271 2020-11-06 11:33:40 +01:00			`## Language-Specific Coding Standards`
THRIFT-2724 - Coding standards template added all over project Client: All Patch: Konrad Grochowski This closes #371 2015-02-04 16:43:26 +01:00
			For detailed information see `lib/LANG/coding_standards.md`