Files
common/docs/CONTRIBUTING.html
T
2019-02-27 13:37:39 +00:00

27 lines
24 KiB
HTML

<!DOCTYPE html>
<html lang="en-US">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Contributing | polkadot-js/common</title>
<meta name="description" content="Utilities and libraries in-use accross @polkadot projects">
<link rel="preload" href="/common/assets/css/0.styles.07dd9036.css" as="style"><link rel="preload" href="/common/assets/js/app.f0407d4e.js" as="script"><link rel="preload" href="/common/assets/js/2.91658b52.js" as="script"><link rel="preload" href="/common/assets/js/5.25bbedf5.js" as="script"><link rel="prefetch" href="/common/assets/js/10.a7d62b8e.js"><link rel="prefetch" href="/common/assets/js/100.59301332.js"><link rel="prefetch" href="/common/assets/js/101.351e45c0.js"><link rel="prefetch" href="/common/assets/js/102.97767b63.js"><link rel="prefetch" href="/common/assets/js/103.b61e49f0.js"><link rel="prefetch" href="/common/assets/js/104.ab2089ef.js"><link rel="prefetch" href="/common/assets/js/105.3f82fb63.js"><link rel="prefetch" href="/common/assets/js/106.b406430a.js"><link rel="prefetch" href="/common/assets/js/107.61de9176.js"><link rel="prefetch" href="/common/assets/js/108.dd287ecf.js"><link rel="prefetch" href="/common/assets/js/109.476f8f9a.js"><link rel="prefetch" href="/common/assets/js/11.0b3c00ee.js"><link rel="prefetch" href="/common/assets/js/110.79820281.js"><link rel="prefetch" href="/common/assets/js/111.b00ef71d.js"><link rel="prefetch" href="/common/assets/js/112.f052ca26.js"><link rel="prefetch" href="/common/assets/js/113.6ed9ef90.js"><link rel="prefetch" href="/common/assets/js/114.2e9cec2b.js"><link rel="prefetch" href="/common/assets/js/115.1610f941.js"><link rel="prefetch" href="/common/assets/js/116.08748b1f.js"><link rel="prefetch" href="/common/assets/js/117.8a49d8d1.js"><link rel="prefetch" href="/common/assets/js/118.5b6e251c.js"><link rel="prefetch" href="/common/assets/js/119.5578e267.js"><link rel="prefetch" href="/common/assets/js/12.42d95e86.js"><link rel="prefetch" href="/common/assets/js/120.fb8a81d4.js"><link rel="prefetch" href="/common/assets/js/121.93ec5853.js"><link rel="prefetch" href="/common/assets/js/122.3af17713.js"><link rel="prefetch" href="/common/assets/js/123.0d9772df.js"><link rel="prefetch" href="/common/assets/js/124.e8d78f8d.js"><link rel="prefetch" href="/common/assets/js/125.9f5ce692.js"><link rel="prefetch" href="/common/assets/js/126.96b92231.js"><link rel="prefetch" href="/common/assets/js/127.a76256c9.js"><link rel="prefetch" href="/common/assets/js/128.60aadccc.js"><link rel="prefetch" href="/common/assets/js/129.df163b43.js"><link rel="prefetch" href="/common/assets/js/13.10b6985f.js"><link rel="prefetch" href="/common/assets/js/130.808dcd2d.js"><link rel="prefetch" href="/common/assets/js/131.2e9f3383.js"><link rel="prefetch" href="/common/assets/js/132.a30547ec.js"><link rel="prefetch" href="/common/assets/js/133.85b96209.js"><link rel="prefetch" href="/common/assets/js/134.2e69d90e.js"><link rel="prefetch" href="/common/assets/js/135.69750875.js"><link rel="prefetch" href="/common/assets/js/136.3e707dbc.js"><link rel="prefetch" href="/common/assets/js/137.94f85f41.js"><link rel="prefetch" href="/common/assets/js/138.7fbb24b4.js"><link rel="prefetch" href="/common/assets/js/139.20c985ff.js"><link rel="prefetch" href="/common/assets/js/14.7d10643d.js"><link rel="prefetch" href="/common/assets/js/140.72c670f1.js"><link rel="prefetch" href="/common/assets/js/141.086b4f99.js"><link rel="prefetch" href="/common/assets/js/142.c2e9ec82.js"><link rel="prefetch" href="/common/assets/js/143.fe037ddc.js"><link rel="prefetch" href="/common/assets/js/144.a78b3a5f.js"><link rel="prefetch" href="/common/assets/js/145.28ee1165.js"><link rel="prefetch" href="/common/assets/js/146.c8bbaeb6.js"><link rel="prefetch" href="/common/assets/js/147.7a57f59b.js"><link rel="prefetch" href="/common/assets/js/148.7bb6dbea.js"><link rel="prefetch" href="/common/assets/js/149.a3e7ae96.js"><link rel="prefetch" href="/common/assets/js/15.0a133331.js"><link rel="prefetch" href="/common/assets/js/150.f11e0808.js"><link rel="prefetch" href="/common/assets/js/151.c81ff91c.js"><link rel="prefetch" href="/common/assets/js/152.4e760fb2.js"><link rel="prefetch" href="/common/assets/js/153.e0f9ed0c.js"><link rel="prefetch" href="/common/assets/js/154.015aad29.js"><link rel="prefetch" href="/common/assets/js/155.3443afb2.js"><link rel="prefetch" href="/common/assets/js/156.f7dbfe83.js"><link rel="prefetch" href="/common/assets/js/157.41d742e9.js"><link rel="prefetch" href="/common/assets/js/158.4a2dc315.js"><link rel="prefetch" href="/common/assets/js/159.2d27b0b6.js"><link rel="prefetch" href="/common/assets/js/16.95f9e19e.js"><link rel="prefetch" href="/common/assets/js/160.392344ae.js"><link rel="prefetch" href="/common/assets/js/161.7cf36eee.js"><link rel="prefetch" href="/common/assets/js/162.44f64348.js"><link rel="prefetch" href="/common/assets/js/163.2a0848e4.js"><link rel="prefetch" href="/common/assets/js/164.b7860497.js"><link rel="prefetch" href="/common/assets/js/165.78fa79ee.js"><link rel="prefetch" href="/common/assets/js/166.57e71a14.js"><link rel="prefetch" href="/common/assets/js/167.7a206b7a.js"><link rel="prefetch" href="/common/assets/js/168.188b11e8.js"><link rel="prefetch" href="/common/assets/js/169.9be3a83b.js"><link rel="prefetch" href="/common/assets/js/17.6241b578.js"><link rel="prefetch" href="/common/assets/js/170.d73e54e4.js"><link rel="prefetch" href="/common/assets/js/171.37084fe5.js"><link rel="prefetch" href="/common/assets/js/172.d6fe72c8.js"><link rel="prefetch" href="/common/assets/js/173.4220b237.js"><link rel="prefetch" href="/common/assets/js/174.c6e66c1a.js"><link rel="prefetch" href="/common/assets/js/175.70e5c759.js"><link rel="prefetch" href="/common/assets/js/176.15bfb8b6.js"><link rel="prefetch" href="/common/assets/js/177.e2daf7e7.js"><link rel="prefetch" href="/common/assets/js/178.15534701.js"><link rel="prefetch" href="/common/assets/js/179.66fbf342.js"><link rel="prefetch" href="/common/assets/js/18.ed93843a.js"><link rel="prefetch" href="/common/assets/js/180.c3d1c1b5.js"><link rel="prefetch" href="/common/assets/js/181.58576ec0.js"><link rel="prefetch" href="/common/assets/js/182.c5233ee2.js"><link rel="prefetch" href="/common/assets/js/183.28e8db00.js"><link rel="prefetch" href="/common/assets/js/184.c1636576.js"><link rel="prefetch" href="/common/assets/js/185.6c3879cf.js"><link rel="prefetch" href="/common/assets/js/186.64b9e7eb.js"><link rel="prefetch" href="/common/assets/js/187.e56346e0.js"><link rel="prefetch" href="/common/assets/js/188.48662e36.js"><link rel="prefetch" href="/common/assets/js/189.c2b5aaa6.js"><link rel="prefetch" href="/common/assets/js/19.5a5f5a6e.js"><link rel="prefetch" href="/common/assets/js/190.586ae7d9.js"><link rel="prefetch" href="/common/assets/js/191.7977240a.js"><link rel="prefetch" href="/common/assets/js/192.c823d3cb.js"><link rel="prefetch" href="/common/assets/js/193.f93560ed.js"><link rel="prefetch" href="/common/assets/js/194.7fba60c5.js"><link rel="prefetch" href="/common/assets/js/195.3357a1d4.js"><link rel="prefetch" href="/common/assets/js/196.46524ef0.js"><link rel="prefetch" href="/common/assets/js/197.57aa1946.js"><link rel="prefetch" href="/common/assets/js/198.4cf5119c.js"><link rel="prefetch" href="/common/assets/js/199.e881ffcd.js"><link rel="prefetch" href="/common/assets/js/20.e904c79f.js"><link rel="prefetch" href="/common/assets/js/200.2faafabd.js"><link rel="prefetch" href="/common/assets/js/201.be55e53b.js"><link rel="prefetch" href="/common/assets/js/202.aef2a3ab.js"><link rel="prefetch" href="/common/assets/js/203.0c671ee6.js"><link rel="prefetch" href="/common/assets/js/204.53c535c3.js"><link rel="prefetch" href="/common/assets/js/205.92e4062d.js"><link rel="prefetch" href="/common/assets/js/206.922e1723.js"><link rel="prefetch" href="/common/assets/js/207.06a7e07b.js"><link rel="prefetch" href="/common/assets/js/208.d887ffab.js"><link rel="prefetch" href="/common/assets/js/209.847c83b5.js"><link rel="prefetch" href="/common/assets/js/21.a364cb6d.js"><link rel="prefetch" href="/common/assets/js/210.e27b80c6.js"><link rel="prefetch" href="/common/assets/js/211.a0f78841.js"><link rel="prefetch" href="/common/assets/js/212.de534506.js"><link rel="prefetch" href="/common/assets/js/213.c65e8739.js"><link rel="prefetch" href="/common/assets/js/214.127b1dff.js"><link rel="prefetch" href="/common/assets/js/215.5ecb85f5.js"><link rel="prefetch" href="/common/assets/js/216.228fed59.js"><link rel="prefetch" href="/common/assets/js/217.a57b59b5.js"><link rel="prefetch" href="/common/assets/js/218.b992b7dc.js"><link rel="prefetch" href="/common/assets/js/219.71680680.js"><link rel="prefetch" href="/common/assets/js/22.215a3f4e.js"><link rel="prefetch" href="/common/assets/js/220.b8eb9653.js"><link rel="prefetch" href="/common/assets/js/221.a6fd0de7.js"><link rel="prefetch" href="/common/assets/js/222.b6d99e16.js"><link rel="prefetch" href="/common/assets/js/223.2d924626.js"><link rel="prefetch" href="/common/assets/js/224.bdbe97de.js"><link rel="prefetch" href="/common/assets/js/225.93a35929.js"><link rel="prefetch" href="/common/assets/js/226.8dea9412.js"><link rel="prefetch" href="/common/assets/js/227.0d081bcb.js"><link rel="prefetch" href="/common/assets/js/228.31c2cf98.js"><link rel="prefetch" href="/common/assets/js/229.168cc500.js"><link rel="prefetch" href="/common/assets/js/23.d960b1d3.js"><link rel="prefetch" href="/common/assets/js/230.d6bbcb74.js"><link rel="prefetch" href="/common/assets/js/231.d3c16932.js"><link rel="prefetch" href="/common/assets/js/232.d923949b.js"><link rel="prefetch" href="/common/assets/js/233.25868229.js"><link rel="prefetch" href="/common/assets/js/234.59e4a11f.js"><link rel="prefetch" href="/common/assets/js/235.d94cbb53.js"><link rel="prefetch" href="/common/assets/js/236.fcd3fccd.js"><link rel="prefetch" href="/common/assets/js/237.103f5d79.js"><link rel="prefetch" href="/common/assets/js/238.6a347f1a.js"><link rel="prefetch" href="/common/assets/js/239.84c9cded.js"><link rel="prefetch" href="/common/assets/js/24.43cdc24f.js"><link rel="prefetch" href="/common/assets/js/240.bb28d758.js"><link rel="prefetch" href="/common/assets/js/241.ad077ec5.js"><link rel="prefetch" href="/common/assets/js/242.8b3eed8b.js"><link rel="prefetch" href="/common/assets/js/243.d3bf27af.js"><link rel="prefetch" href="/common/assets/js/25.57b4f113.js"><link rel="prefetch" href="/common/assets/js/26.50f03fcb.js"><link rel="prefetch" href="/common/assets/js/27.c8a28a38.js"><link rel="prefetch" href="/common/assets/js/28.5729d897.js"><link rel="prefetch" href="/common/assets/js/29.8313abe7.js"><link rel="prefetch" href="/common/assets/js/3.927f0a66.js"><link rel="prefetch" href="/common/assets/js/30.ceb486fb.js"><link rel="prefetch" href="/common/assets/js/31.c481f089.js"><link rel="prefetch" href="/common/assets/js/32.81230239.js"><link rel="prefetch" href="/common/assets/js/33.9cd88591.js"><link rel="prefetch" href="/common/assets/js/34.b26de6b6.js"><link rel="prefetch" href="/common/assets/js/35.1e909cb9.js"><link rel="prefetch" href="/common/assets/js/36.2b49f347.js"><link rel="prefetch" href="/common/assets/js/37.e2bf13b0.js"><link rel="prefetch" href="/common/assets/js/38.f4b813f8.js"><link rel="prefetch" href="/common/assets/js/39.825b9aaf.js"><link rel="prefetch" href="/common/assets/js/4.fa7ee3a8.js"><link rel="prefetch" href="/common/assets/js/40.3312f339.js"><link rel="prefetch" href="/common/assets/js/41.9ed1f3ad.js"><link rel="prefetch" href="/common/assets/js/42.7f31bca0.js"><link rel="prefetch" href="/common/assets/js/43.2e80fc64.js"><link rel="prefetch" href="/common/assets/js/44.e41ceb31.js"><link rel="prefetch" href="/common/assets/js/45.eb57e290.js"><link rel="prefetch" href="/common/assets/js/46.bc129317.js"><link rel="prefetch" href="/common/assets/js/47.308671c3.js"><link rel="prefetch" href="/common/assets/js/48.7224fd0d.js"><link rel="prefetch" href="/common/assets/js/49.de0bc67b.js"><link rel="prefetch" href="/common/assets/js/50.6038feac.js"><link rel="prefetch" href="/common/assets/js/51.5841cdb8.js"><link rel="prefetch" href="/common/assets/js/52.4e84ed63.js"><link rel="prefetch" href="/common/assets/js/53.2f792e8a.js"><link rel="prefetch" href="/common/assets/js/54.26651542.js"><link rel="prefetch" href="/common/assets/js/55.210cf109.js"><link rel="prefetch" href="/common/assets/js/56.d76169df.js"><link rel="prefetch" href="/common/assets/js/57.7e94a702.js"><link rel="prefetch" href="/common/assets/js/58.556e7968.js"><link rel="prefetch" href="/common/assets/js/59.70df5884.js"><link rel="prefetch" href="/common/assets/js/6.4211a0b3.js"><link rel="prefetch" href="/common/assets/js/60.9f43950c.js"><link rel="prefetch" href="/common/assets/js/61.9cb8601e.js"><link rel="prefetch" href="/common/assets/js/62.64ad0b2c.js"><link rel="prefetch" href="/common/assets/js/63.27c157ab.js"><link rel="prefetch" href="/common/assets/js/64.b617ab6c.js"><link rel="prefetch" href="/common/assets/js/65.a77b266f.js"><link rel="prefetch" href="/common/assets/js/66.7fb32ca9.js"><link rel="prefetch" href="/common/assets/js/67.f61eeb14.js"><link rel="prefetch" href="/common/assets/js/68.5b681ce4.js"><link rel="prefetch" href="/common/assets/js/69.349aae5c.js"><link rel="prefetch" href="/common/assets/js/7.9cff3c08.js"><link rel="prefetch" href="/common/assets/js/70.d3d46356.js"><link rel="prefetch" href="/common/assets/js/71.cb211dfd.js"><link rel="prefetch" href="/common/assets/js/72.46a30d0c.js"><link rel="prefetch" href="/common/assets/js/73.98b2beb7.js"><link rel="prefetch" href="/common/assets/js/74.e019699f.js"><link rel="prefetch" href="/common/assets/js/75.361ba2a4.js"><link rel="prefetch" href="/common/assets/js/76.676d4105.js"><link rel="prefetch" href="/common/assets/js/77.80b74117.js"><link rel="prefetch" href="/common/assets/js/78.d10417ab.js"><link rel="prefetch" href="/common/assets/js/79.f7213df9.js"><link rel="prefetch" href="/common/assets/js/8.2bf8cee0.js"><link rel="prefetch" href="/common/assets/js/80.43aef255.js"><link rel="prefetch" href="/common/assets/js/81.93329234.js"><link rel="prefetch" href="/common/assets/js/82.749c1d52.js"><link rel="prefetch" href="/common/assets/js/83.e187b60d.js"><link rel="prefetch" href="/common/assets/js/84.8bf395ab.js"><link rel="prefetch" href="/common/assets/js/85.f2b7150e.js"><link rel="prefetch" href="/common/assets/js/86.0a996abb.js"><link rel="prefetch" href="/common/assets/js/87.c3880025.js"><link rel="prefetch" href="/common/assets/js/88.e9ab5c90.js"><link rel="prefetch" href="/common/assets/js/89.d329bfcf.js"><link rel="prefetch" href="/common/assets/js/9.59c788c0.js"><link rel="prefetch" href="/common/assets/js/90.5c9e2e62.js"><link rel="prefetch" href="/common/assets/js/91.0f3edb7f.js"><link rel="prefetch" href="/common/assets/js/92.820a8d76.js"><link rel="prefetch" href="/common/assets/js/93.5d25ff26.js"><link rel="prefetch" href="/common/assets/js/94.9c493ab4.js"><link rel="prefetch" href="/common/assets/js/95.ce53dfe3.js"><link rel="prefetch" href="/common/assets/js/96.4a58e023.js"><link rel="prefetch" href="/common/assets/js/97.5b9e46d3.js"><link rel="prefetch" href="/common/assets/js/98.c35cb11e.js"><link rel="prefetch" href="/common/assets/js/99.b0ad8e8a.js">
<link rel="stylesheet" href="/common/assets/css/0.styles.07dd9036.css">
</head>
<body>
<div id="app" data-server-rendered="true"><div class="theme-container"><header class="navbar"><div class="sidebar-button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512" class="icon"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"></path></svg></div> <a href="/common/" class="home-link router-link-active"><!----> <span class="site-name">polkadot-js/common</span></a> <div class="links"><div class="search-box"><input aria-label="Search" autocomplete="off" spellcheck="false" value=""> <!----></div> <nav class="nav-links can-hide"><div class="nav-item"><a href="https://github.com/polkadot-js/common" target="_blank" rel="noopener noreferrer" class="nav-link external">
GitHub
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div> <!----></nav></div></header> <div class="sidebar-mask"></div> <aside class="sidebar"><nav class="nav-links"><div class="nav-item"><a href="https://github.com/polkadot-js/common" target="_blank" rel="noopener noreferrer" class="nav-link external">
GitHub
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div> <!----></nav> <ul class="sidebar-links"><li><section class="sidebar-group depth-0"><a href="/common/examples/keyring/" class="sidebar-heading clickable open"><span>Examples (keyring)</span> <!----></a> <ul class="sidebar-links sidebar-group-items"><li><a href="/common/examples/keyring/01_create_account/" class="sidebar-link">Create account</a></li><li><a href="/common/examples/keyring/02_load_accounts/" class="sidebar-link">Load Accounts</a></li></ul></section></li><li><a href="/common/util/" class="sidebar-link">@polkadot/util</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/common/util/#usage" class="sidebar-link">Usage</a></li><li class="sidebar-sub-header"><a href="/common/util/#utilities" class="sidebar-link">Utilities</a></li></ul></li><li><a href="/common/util-crypto/" class="sidebar-link">@polkadot/util-crypto</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/common/util-crypto/#usage" class="sidebar-link">Usage</a></li><li class="sidebar-sub-header"><a href="/common/util-crypto/#utilities" class="sidebar-link">Utilities</a></li></ul></li><li><a href="/common/keyring/" class="sidebar-link">@polkadot/keyring</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/common/keyring/#usage" class="sidebar-link">Usage</a></li><li class="sidebar-sub-header"><a href="/common/keyring/#utilities" class="sidebar-link">Utilities</a></li></ul></li><li><a href="/common/CONTRIBUTING.html" class="active sidebar-link">Contributing</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/common/CONTRIBUTING.html#what" class="sidebar-link">What?</a></li><li class="sidebar-sub-header"><a href="/common/CONTRIBUTING.html#rules" class="sidebar-link">Rules</a></li><li class="sidebar-sub-header"><a href="/common/CONTRIBUTING.html#releases" class="sidebar-link">Releases</a></li><li class="sidebar-sub-header"><a href="/common/CONTRIBUTING.html#changes-to-this-arrangement" class="sidebar-link">Changes to this arrangement</a></li><li class="sidebar-sub-header"><a href="/common/CONTRIBUTING.html#heritage" class="sidebar-link">Heritage</a></li></ul></li></ul> </aside> <main class="page"> <div class="content default"><h1 id="contributing"><a href="#contributing" aria-hidden="true" class="header-anchor">#</a> Contributing</h1> <h2 id="what"><a href="#what" aria-hidden="true" class="header-anchor">#</a> What?</h2> <p>Individuals making significant and valuable contributions are given commit-access to a project to contribute as they see fit.
A project is more like an open wiki than a standard guarded open source project.</p> <h2 id="rules"><a href="#rules" aria-hidden="true" class="header-anchor">#</a> Rules</h2> <p>There are a few basic ground-rules for contributors (including the maintainer(s) of the project):</p> <ol><li><strong>No <code>--force</code> pushes</strong> or modifying the Git history in any way. If you need to rebase, ensure you do it in your own repo.</li> <li><strong>Non-master branches</strong>, prefixed with a short name moniker (e.g. <code>&lt;initials&gt;-&lt;feature&gt;</code>) must be used for ongoing work.</li> <li><strong>All modifications</strong> must be made in a <strong>pull-request</strong> to solicit feedback from other contributors.</li> <li>A pull-request <em>must not be merged until CI</em> has finished successfully.</li></ol> <h4 id="merging-pull-requests-once-ci-is-successful"><a href="#merging-pull-requests-once-ci-is-successful" aria-hidden="true" class="header-anchor">#</a> Merging pull requests once CI is successful:</h4> <ul><li>A pull request with no large change to logic that is an urgent fix may be merged after a non-author contributor has reviewed it well.</li> <li>No PR should be merged until all reviews' comments are addressed.</li></ul> <h4 id="reviewing-pull-requests"><a href="#reviewing-pull-requests" aria-hidden="true" class="header-anchor">#</a> Reviewing pull requests:</h4> <p>When reviewing a pull request, the end-goal is to suggest useful changes to the author. Reviews should finish with approval unless there are issues that would result in:</p> <ul><li>Buggy behaviour.</li> <li>Undue maintenance burden.</li> <li>Breaking with house coding style.</li> <li>Pessimisation (i.e. reduction of speed as measured in the projects benchmarks).</li> <li>Feature reduction (i.e. it removes some aspect of functionality that a significant minority of users rely on).</li> <li>Uselessness (i.e. it does not strictly add a feature or fix a known issue).</li></ul> <h4 id="reviews-may-not-be-used-as-an-effective-veto-for-a-pr-because"><a href="#reviews-may-not-be-used-as-an-effective-veto-for-a-pr-because" aria-hidden="true" class="header-anchor">#</a> Reviews may not be used as an effective veto for a PR because:</h4> <ul><li>There exists a somewhat cleaner/better/faster way of accomplishing the same feature/fix.</li> <li>It does not fit well with some other contributors' longer-term vision for the project.</li></ul> <h2 id="releases"><a href="#releases" aria-hidden="true" class="header-anchor">#</a> Releases</h2> <p>Declaring formal releases remains the prerogative of the project maintainer(s).</p> <h2 id="changes-to-this-arrangement"><a href="#changes-to-this-arrangement" aria-hidden="true" class="header-anchor">#</a> Changes to this arrangement</h2> <p>This is an experiment and feedback is welcome! This document may also be subject to pull-requests or changes by contributors where you believe you have something valuable to add or change.</p> <h2 id="heritage"><a href="#heritage" aria-hidden="true" class="header-anchor">#</a> Heritage</h2> <p>These contributing guidelines are modified from the &quot;OPEN Open Source Project&quot; guidelines for the Level project: <a href="https://github.com/Level/community/blob/master/CONTRIBUTING.md" target="_blank" rel="noopener noreferrer">https://github.com/Level/community/blob/master/CONTRIBUTING.md<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></p></div> <footer class="page-edit"><!----> <div class="last-updated"><span class="prefix">Last Updated: </span> <span class="time">2/27/2019, 12:50:09 PM</span></div></footer> <div class="page-nav"><p class="inner"><span class="prev">
←
<a href="/common/keyring/" class="prev">
@polkadot/keyring
</a></span> <!----></p></div> </main></div><div class="global-ui"></div></div>
<script src="/common/assets/js/app.f0407d4e.js" defer></script><script src="/common/assets/js/2.91658b52.js" defer></script><script src="/common/assets/js/5.25bbedf5.js" defer></script>
</body>
</html>