You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@thrift.apache.org by bu...@apache.org on 2015/10/05 21:56:52 UTC
svn commit: r967861 - in /websites/staging/thrift/trunk/content: ./
docs/coding_standards.html docs/index.html sitemap.html
Author: buildbot
Date: Mon Oct 5 19:56:52 2015
New Revision: 967861
Log:
Staging update by buildbot for thrift
Added:
websites/staging/thrift/trunk/content/docs/coding_standards.html
Modified:
websites/staging/thrift/trunk/content/ (props changed)
websites/staging/thrift/trunk/content/docs/index.html
websites/staging/thrift/trunk/content/sitemap.html
Propchange: websites/staging/thrift/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Mon Oct 5 19:56:52 2015
@@ -1 +1 @@
-1706509
+1706910
Added: websites/staging/thrift/trunk/content/docs/coding_standards.html
==============================================================================
--- websites/staging/thrift/trunk/content/docs/coding_standards.html (added)
+++ websites/staging/thrift/trunk/content/docs/coding_standards.html Mon Oct 5 19:56:52 2015
@@ -0,0 +1,164 @@
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
+ <meta content="en-us" http-equiv="Content-Language" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <link href="/static/images/favicon.ico" rel="shortcut icon" />
+ <link href="/static/css/style.css" rel="stylesheet" type="text/css" />
+ <link href="/static/css/codehilite.css" rel="stylesheet" type="text/css" />
+ <link href="/static/css/bootstrap.css" media="screen, projection" rel="stylesheet" type="text/css" />
+
+ <script src="/static/js/jquery.min.js"></script>
+ <script src="/static/js/bootstrap-dropdown.js"></script>
+ <script src="/static/js/bootstrap-tab.js"></script>
+
+ <title>Apache Thrift - Coding standards</title>
+ </head>
+ <body>
+ <div class="navbar">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="brand" href="/">Apache Thrift ™</a>
+ <div class="nav-collapse">
+ <ul class="nav pull-right">
+ <li>
+ <a href="/download">Download</a>
+ </li>
+ <li>
+ <a href="/docs">Documentation</a>
+ </li>
+ <li>
+ <a href="/developers">Developers</a>
+ </li>
+ <li>
+ <a href="/lib">Libraries</a>
+ </li>
+ <li>
+ <a href="/tutorial">Tutorial</a>
+ </li>
+ <li>
+ <a href="/test">Test Suite</a>
+ </li>
+ <li>
+ <a href="/about">About</a>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">
+ Apache <b class="caret"></b>
+ </a>
+ <ul class="dropdown-menu">
+ <li>
+ <a href="http://www.apache.org/" target="_blank">Apache Home</a>
+ </li>
+ <li>
+ <a href="http://www.apache.org/licenses/" target="_blank">Apache License v2.0</a>
+ </li>
+ <li>
+ <a href="http://www.apache.org/foundation/sponsorship.html" target="_blank">Donate</a>
+ </li>
+ <li>
+ <a href="http://www.apache.org/foundation/thanks.html" target="_blank">Thanks</a>
+ </li>
+ <li>
+ <a href="http://www.apache.org/security/" target="_blank">Security</a>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </div>
+ </div>
+ </div>
+</div>
+
+ <div class="container">
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<h1 id="thrift-coding-standards">Thrift Coding Standards<a class="headerlink" href="#thrift-coding-standards" title="Permanent link">¶</a></h1>
+<p>Any fool can write code that a computer can understand.
+ Good programmers write code that humans can understand.
+ -- Martin Fowler, 1999</p>
+<p>The purpose of this document is to make everyone's life easier.</p>
+<p>It's easier when you read good, well formatted, with clearly defined purpose, code.
+But the only way to read clean code is to write such.</p>
+<p>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.
+Write code like you would have to read it in ten years from now.</p>
+<h2 id="general-coding-standards">General Coding Standards<a class="headerlink" href="#general-coding-standards" title="Permanent link">¶</a></h2>
+<p>Thrift has some history. Not all existing code follows those rules.
+But we want to improve over time.
+When making small change / bugfix - like single line fix - do <em>not</em> refactor whole function.
+That disturbs code repository history.
+Whenever adding something new and / or making bigger refactoring
+ - follow those rules as strictly as you can.</p>
+<p>When in doubt - contact other developers (using dev@ mailing list or IRC).
+Code review is the best way to improve readability.</p>
+<h3 id="basics">Basics<a class="headerlink" href="#basics" title="Permanent link">¶</a></h3>
+<ul>
+<li>Use spaces not tabs</li>
+<li>Use only ASCII characters in file and directory names</li>
+<li>Commit to repository using Unix-style line endings (LF)
+ On Windows:
+ git config core.autocrlf true</li>
+<li>Maximum line width - 100 characters</li>
+<li>If not specified otherwise in language specific standard - use 2 spaces as indent/tab</li>
+</ul>
+<h3 id="comments">Comments<a class="headerlink" href="#comments" title="Permanent link">¶</a></h3>
+<ul>
+<li>Each file has to start with comment containing <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License</a></li>
+<li>Public API of library should be documented, preferably using format native for language specific documentation generation tools (Javadoc, Doxygen etc.)</li>
+<li>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"</li>
+<li>Do not leave "TODO/FIXME" comments - file <a href="http://issues.apache.org/jira/browse/THRIFT">Jira</a> issue instead</li>
+</ul>
+<h3 id="naming">Naming<a class="headerlink" href="#naming" title="Permanent link">¶</a></h3>
+<p>Finding proper names is the most important and most difficult task in software development.</p>
+<h2 id="language-specific-coding-standards">Language Specific Coding Standards<a class="headerlink" href="#language-specific-coding-standards" title="Permanent link">¶</a></h2>
+<p>For detailed information see <code>lib/LANG/coding_standards.md</code></p>
+<p class='snippet_footer'>
+ This snippet was generated by Apache Thrift's <strong>source tree docs</strong>:
+ <a href="http://git-wip-us.apache.org/repos/asf?p=thrift.git;a=blob;f=doc/coding_standards.md;hb=HEAD"</a>doc/coding_standards.md</a>
+</p>
+ </div>
+ <div class="container">
+ <hr>
+ <footer class="footer">
+ <div class="row">
+ <div class="span3">
+ <h3>Links</h3>
+ <ul class="unstyled">
+ <li><a href="/download">Download</a></li>
+ <li><a href="/developers">Developers</a></li>
+ <li><a href="/tutorial">Tutorials</a></li>
+ </ul>
+ <ul class="unstyled">
+ <li><a href="/sitemap">Sitemap</a></li>
+ </ul>
+ </div>
+ <div class="span3">
+ <h3>Get Involved</h3>
+ <ul class="unstyled">
+ <li><a href="/mailing">Mailing Lists</a></li>
+ <li><a href="http://issues.apache.org/jira/browse/THRIFT">Issue Tracking</a></li>
+ <li><a href="/docs/HowToContribute">How To Contribute</a></li>
+ </ul>
+ </div>
+ <div class="span6">
+ <a href="http://www.apache.org/"><img src="/static/images/favicon.ico" /></a> Copyright 2015 <a href="http://www.apache.org/">Apache Software Foundation</a>. Licensed under the <a href="http://www.apache.org/licenses/">Apache License v2.0</a>. Apache, Apache Thrift, and the Apache feather logo are trademarks of The Apache Software Foundation.
+ </div>
+ </div>
+
+ </footer>
+</div>
+
+ </body>
+</html>
Modified: websites/staging/thrift/trunk/content/docs/index.html
==============================================================================
--- websites/staging/thrift/trunk/content/docs/index.html (original)
+++ websites/staging/thrift/trunk/content/docs/index.html Mon Oct 5 19:56:52 2015
@@ -88,6 +88,7 @@ h2:hover > .headerlink, h3:hover > .head
<li><a href="/docs/BuildingFromSource">Building From Source</a></li>
<li><a href="/docs/HowToContribute">How To Contribute</a></li>
<li><a href="/docs/HowToNewLanguage">How to add new language bindings</a></li>
+<li><a href="/docs/coding_standards">Coding standards</a></li>
<li><a href="/docs/committers/">Index of committers/</a></li>
<li><a href="/docs/concepts">Concepts</a></li>
<li><a href="/docs/features">Features</a></li>
Modified: websites/staging/thrift/trunk/content/sitemap.html
==============================================================================
--- websites/staging/thrift/trunk/content/sitemap.html (original)
+++ websites/staging/thrift/trunk/content/sitemap.html Mon Oct 5 19:56:52 2015
@@ -92,6 +92,7 @@ h2:hover > .headerlink, h3:hover > .head
<li><a href="/docs/BuildingFromSource">Building From Source</a></li>
<li><a href="/docs/HowToContribute">How To Contribute</a></li>
<li><a href="/docs/HowToNewLanguage">How to add new language bindings</a></li>
+<li><a href="/docs/coding_standards">Coding standards</a></li>
<li><a href="/docs/committers/">Index of committers/</a><ul>
<li><a href="/docs/committers/AdditionalReading">General articles and links for committers</a></li>
<li><a href="/docs/committers/HowToCommit">How To Commit</a></li>