1
0
mirror of https://github.com/tmrts/go-patterns.git synced 2024-11-25 14:36:06 +03:00
go-patterns/CONTRIBUTING.html

1048 lines
24 KiB
HTML

<!DOCTYPE HTML>
<html lang="" >
<head>
<meta charset="UTF-8">
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<title>Contributing · GitBook</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="description" content="">
<meta name="generator" content="GitBook 3.2.2">
<link rel="stylesheet" href="gitbook/style.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-highlight/website.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-fontsettings/website.css">
<meta name="HandheldFriendly" content="true"/>
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<link rel="apple-touch-icon-precomposed" sizes="152x152" href="gitbook/images/apple-touch-icon-precomposed-152.png">
<link rel="shortcut icon" href="gitbook/images/favicon.ico" type="image/x-icon">
<link rel="prev" href="anti-patterns/cascading_failures.md" />
</head>
<body>
<div class="book">
<div class="book-summary">
<nav role="navigation">
<ul class="summary">
<li class="chapter " data-level="1.1" data-path="./">
<a href="./">
Go Patterns
</a>
<ul class="articles">
<li class="chapter " data-level="1.1.1" data-path="./">
<a href="./#creational-patterns">
Creational Patterns
</a>
<ul class="articles">
<li class="chapter " data-level="1.1.1.1" data-path="creational/abstract_factory.md">
<span>
Abstract Factory
</a>
</li>
<li class="chapter " data-level="1.1.1.2" data-path="creational/builder.html">
<a href="creational/builder.html">
Builder
</a>
</li>
<li class="chapter " data-level="1.1.1.3" data-path="creational/factory.html">
<a href="creational/factory.html">
Factory Method
</a>
</li>
<li class="chapter " data-level="1.1.1.4" data-path="creational/object-pool.html">
<a href="creational/object-pool.html">
Object Pool
</a>
</li>
<li class="chapter " data-level="1.1.1.5" data-path="creational/singleton.html">
<a href="creational/singleton.html">
Singleton
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.1.2" data-path="./">
<a href="./#structural-patterns">
Structural Patterns
</a>
<ul class="articles">
<li class="chapter " data-level="1.1.2.1" data-path="structural/bridge.md">
<span>
Bridge
</a>
</li>
<li class="chapter " data-level="1.1.2.2" data-path="structural/composite.md">
<span>
Composite
</a>
</li>
<li class="chapter " data-level="1.1.2.3" data-path="structural/decorator.html">
<a href="structural/decorator.html">
Decorator
</a>
</li>
<li class="chapter " data-level="1.1.2.4" data-path="structural/facade.md">
<span>
Facade
</a>
</li>
<li class="chapter " data-level="1.1.2.5" data-path="structural/flyweight.md">
<span>
Flyweight
</a>
</li>
<li class="chapter " data-level="1.1.2.6" data-path="structural/proxy.md">
<span>
Proxy
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.1.3" data-path="./">
<a href="./#behavioral-patterns">
Behavioral Patterns
</a>
<ul class="articles">
<li class="chapter " data-level="1.1.3.1" data-path="behavioral/chain_of_responsibility.md">
<span>
Chain of Responsibility
</a>
</li>
<li class="chapter " data-level="1.1.3.2" data-path="behavioral/command.md">
<span>
Command
</a>
</li>
<li class="chapter " data-level="1.1.3.3" data-path="behavioral/mediator.md">
<span>
Mediator
</a>
</li>
<li class="chapter " data-level="1.1.3.4" data-path="behavioral/memento.md">
<span>
Memento
</a>
</li>
<li class="chapter " data-level="1.1.3.5" data-path="behavioral/observer.html">
<a href="behavioral/observer.html">
Observer
</a>
</li>
<li class="chapter " data-level="1.1.3.6" data-path="behavioral/registry.md">
<span>
Registry
</a>
</li>
<li class="chapter " data-level="1.1.3.7" data-path="behavioral/state.md">
<span>
State
</a>
</li>
<li class="chapter " data-level="1.1.3.8" data-path="behavioral/strategy.html">
<a href="behavioral/strategy.html">
Strategy
</a>
</li>
<li class="chapter " data-level="1.1.3.9" data-path="behavioral/template.md">
<span>
Template
</a>
</li>
<li class="chapter " data-level="1.1.3.10" data-path="behavioral/visitor.md">
<span>
Visitor
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.1.4" data-path="./">
<a href="./#synchronization-patterns">
Synchronization Patterns
</a>
<ul class="articles">
<li class="chapter " data-level="1.1.4.1" data-path="synchronization/condition_variable.md">
<span>
Condition Variable
</a>
</li>
<li class="chapter " data-level="1.1.4.2" data-path="synchronization/mutex.md">
<span>
Lock/Mutex
</a>
</li>
<li class="chapter " data-level="1.1.4.3" data-path="synchronization/monitor.md">
<span>
Monitor
</a>
</li>
<li class="chapter " data-level="1.1.4.4" data-path="synchronization/read_write_lock.md">
<span>
Read-Write Lock
</a>
</li>
<li class="chapter " data-level="1.1.4.5" data-path="synchronization/semaphore.html">
<a href="synchronization/semaphore.html">
Semaphore
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.1.5" data-path="./">
<a href="./#concurrency-patterns">
Concurrency Patterns
</a>
<ul class="articles">
<li class="chapter " data-level="1.1.5.1" data-path="concurrency/barrier.md">
<span>
N-Barrier
</a>
</li>
<li class="chapter " data-level="1.1.5.2" data-path="concurrency/bounded_parallelism.html">
<a href="concurrency/bounded_parallelism.html">
Bounded Parallelism
</a>
</li>
<li class="chapter " data-level="1.1.5.3" data-path="concurrency/broadcast.md">
<span>
Broadcast
</a>
</li>
<li class="chapter " data-level="1.1.5.4" data-path="concurrency/coroutine.md">
<span>
Coroutines
</a>
</li>
<li class="chapter " data-level="1.1.5.5" data-path="concurrency/generator.html">
<a href="concurrency/generator.html">
Generators
</a>
</li>
<li class="chapter " data-level="1.1.5.6" data-path="concurrency/reactor.md">
<span>
Reactor
</a>
</li>
<li class="chapter " data-level="1.1.5.7" data-path="concurrency/parallelism.html">
<a href="concurrency/parallelism.html">
Parallelism
</a>
</li>
<li class="chapter " data-level="1.1.5.8" data-path="concurrency/producer_consumer.md">
<span>
Producer Consumer
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.1.6" data-path="./">
<a href="./#messaging-patterns">
Messaging Patterns
</a>
<ul class="articles">
<li class="chapter " data-level="1.1.6.1" data-path="messaging/fan_in.html">
<a href="messaging/fan_in.html">
Fan-In
</a>
</li>
<li class="chapter " data-level="1.1.6.2" data-path="messaging/fan_out.html">
<a href="messaging/fan_out.html">
Fan-Out
</a>
</li>
<li class="chapter " data-level="1.1.6.3" data-path="messaging/futures_promises.md">
<span>
Futures & Promises
</a>
</li>
<li class="chapter " data-level="1.1.6.4" data-path="messaging/publish_subscribe.html">
<a href="messaging/publish_subscribe.html">
Publish/Subscribe
</a>
</li>
<li class="chapter " data-level="1.1.6.5" data-path="messaging/push_pull.md">
<span>
Push & Pull
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.1.7" data-path="./">
<a href="./#stability-patterns">
Stability Patterns
</a>
<ul class="articles">
<li class="chapter " data-level="1.1.7.1" data-path="stability/bulkhead.md">
<span>
Bulkheads
</a>
</li>
<li class="chapter " data-level="1.1.7.2" data-path="stability/circuit-breaker.html">
<a href="stability/circuit-breaker.html">
Circuit-Breaker
</a>
</li>
<li class="chapter " data-level="1.1.7.3" data-path="stability/deadline.md">
<span>
Deadline
</a>
</li>
<li class="chapter " data-level="1.1.7.4" data-path="stability/fail_fast.md">
<span>
Fail-Fast
</a>
</li>
<li class="chapter " data-level="1.1.7.5" data-path="stability/handshaking.md">
<span>
Handshaking
</a>
</li>
<li class="chapter " data-level="1.1.7.6" data-path="stability/steady_state.md">
<span>
Steady-State
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.1.8" data-path="./">
<a href="./#profiling-patterns">
Profiling Patterns
</a>
<ul class="articles">
<li class="chapter " data-level="1.1.8.1" data-path="profiling/timing.html">
<a href="profiling/timing.html">
Timing Functions
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.1.9" data-path="./">
<a href="./#idioms">
Idioms
</a>
<ul class="articles">
<li class="chapter " data-level="1.1.9.1" data-path="idiom/functional-options.html">
<a href="idiom/functional-options.html">
Functional Options
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.1.10" data-path="./">
<a href="./#anti-patterns">
Anti-Patterns
</a>
<ul class="articles">
<li class="chapter " data-level="1.1.10.1" data-path="anti-patterns/cascading_failures.md">
<span>
Cascading Failures
</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="chapter active" data-level="1.2" data-path="CONTRIBUTING.html">
<a href="CONTRIBUTING.html">
Contributing
</a>
</li>
<li class="divider"></li>
<li>
<a href="https://www.gitbook.com" target="blank" class="gitbook-link">
Published with GitBook
</a>
</li>
</ul>
</nav>
</div>
<div class="book-body">
<div class="body-inner">
<div class="book-header" role="navigation">
<!-- Title -->
<h1>
<i class="fa fa-circle-o-notch fa-spin"></i>
<a href="." >Contributing</a>
</h1>
</div>
<div class="page-wrapper" tabindex="-1" role="main">
<div class="page-inner">
<section class="normal markdown-section">
<h1 id="contribution-guidelines">Contribution Guidelines</h1>
<p>Please ensure your pull request adheres to the following guidelines:</p>
<ul>
<li>Make an individual pull request for each suggestion.</li>
<li>Choose the corresponding patterns section for your suggestion.</li>
<li>List, after your addition, should be in lexicographical order.</li>
</ul>
<h2 id="commit-messages-guidelines">Commit Messages Guidelines</h2>
<ul>
<li>The message should be in imperative form and uncapitalized.</li>
<li>If possible, please include an explanation in the commit message body</li>
<li>Use the form <code>&lt;pattern-section&gt;/&lt;pattern-name&gt;: &lt;message&gt;</code> (e.g. <code>creational/singleton: refactor singleton constructor</code>)</li>
</ul>
<h2 id="pattern-template">Pattern Template</h2>
<p>Each pattern should have a single markdown file containing the important part of the implementation, the usage and the explanations for it. This is to ensure that the reader doesn&apos;t have to read bunch of boilerplate to understand what&apos;s going on and the code is as simple as possible and not simpler.</p>
<p>Please use the following template for adding new patterns:</p>
<pre><code class="lang-markdown"><span class="hljs-section"># &lt;Pattern-Name&gt;</span>
<span class="xml"><span class="hljs-tag">&lt;<span class="hljs-name">Pattern</span> <span class="hljs-attr">description</span>&gt;</span></span>
<span class="hljs-section">## Implementation</span>
<span class="hljs-section">## Usage</span>
// Optional
<span class="hljs-section">## Rules of Thumb</span>
</code></pre>
</section>
</div>
</div>
</div>
<a href="anti-patterns/cascading_failures.md" class="navigation navigation-prev navigation-unique" aria-label="Previous page: Cascading Failures">
<i class="fa fa-angle-left"></i>
</a>
</div>
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Contributing","level":"1.2","depth":1,"previous":{"title":"Cascading Failures","level":"1.1.10.1","depth":3,"path":"anti-patterns/cascading_failures.md","ref":"anti-patterns/cascading_failures.md","articles":[]},"dir":"ltr"},"config":{"gitbook":"*","theme":"default","variables":{},"plugins":["-search","-lunr","github","edit-link"],"pluginsConfig":{"github":{"url":"https://github.com/tmrts/go-patterns"},"edit-link":{"label":"","base":"https://github.com/tmrts/go-patterns/edit/master/"},"highlight":{},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"}},"file":{"path":"CONTRIBUTING.md","mtime":"2017-05-01T12:22:21.000Z","type":"markdown"},"gitbook":{"version":"3.2.2","time":"2017-05-01T12:23:41.783Z"},"basePath":".","book":{"language":""}});
});
</script>
</div>
<script src="gitbook/gitbook.js"></script>
<script src="gitbook/theme.js"></script>
<script src="gitbook/gitbook-plugin-github/plugin.js"></script>
<script src="gitbook/gitbook-plugin-edit-link/plugin.js"></script>
<script src="gitbook/gitbook-plugin-sharing/buttons.js"></script>
<script src="gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
</body>
</html>