39 lines
23 KiB
HTML
39 lines
23 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.1af07c41.js" as="script"><link rel="preload" href="/common/assets/js/2.91658b52.js" as="script"><link rel="preload" href="/common/assets/js/5.273314fb.js" as="script"><link rel="prefetch" href="/common/assets/js/10.e3de6e32.js"><link rel="prefetch" href="/common/assets/js/100.eada1ee7.js"><link rel="prefetch" href="/common/assets/js/101.c0266c71.js"><link rel="prefetch" href="/common/assets/js/102.bbdf1551.js"><link rel="prefetch" href="/common/assets/js/103.2b40a00a.js"><link rel="prefetch" href="/common/assets/js/104.08626032.js"><link rel="prefetch" href="/common/assets/js/105.3756f026.js"><link rel="prefetch" href="/common/assets/js/106.9b5387d2.js"><link rel="prefetch" href="/common/assets/js/107.ac0410cf.js"><link rel="prefetch" href="/common/assets/js/108.4b0bb2fe.js"><link rel="prefetch" href="/common/assets/js/109.f796e243.js"><link rel="prefetch" href="/common/assets/js/11.ea4175ac.js"><link rel="prefetch" href="/common/assets/js/110.a164004c.js"><link rel="prefetch" href="/common/assets/js/111.b00ef71d.js"><link rel="prefetch" href="/common/assets/js/112.3bdcdd17.js"><link rel="prefetch" href="/common/assets/js/113.a1e71949.js"><link rel="prefetch" href="/common/assets/js/114.e6b445cc.js"><link rel="prefetch" href="/common/assets/js/115.62463929.js"><link rel="prefetch" href="/common/assets/js/116.1dd89c9b.js"><link rel="prefetch" href="/common/assets/js/117.85c78ed2.js"><link rel="prefetch" href="/common/assets/js/118.cc136900.js"><link rel="prefetch" href="/common/assets/js/119.294e232e.js"><link rel="prefetch" href="/common/assets/js/12.42d95e86.js"><link rel="prefetch" href="/common/assets/js/120.83f82f71.js"><link rel="prefetch" href="/common/assets/js/121.b9ffa863.js"><link rel="prefetch" href="/common/assets/js/122.4129636d.js"><link rel="prefetch" href="/common/assets/js/123.390c7af8.js"><link rel="prefetch" href="/common/assets/js/124.bf8a9f43.js"><link rel="prefetch" href="/common/assets/js/125.f7a60723.js"><link rel="prefetch" href="/common/assets/js/126.d301e959.js"><link rel="prefetch" href="/common/assets/js/127.d0a7193e.js"><link rel="prefetch" href="/common/assets/js/128.f42a132c.js"><link rel="prefetch" href="/common/assets/js/129.4d3a6550.js"><link rel="prefetch" href="/common/assets/js/13.10b6985f.js"><link rel="prefetch" href="/common/assets/js/130.d0dd4775.js"><link rel="prefetch" href="/common/assets/js/131.5391d115.js"><link rel="prefetch" href="/common/assets/js/132.3c1a5562.js"><link rel="prefetch" href="/common/assets/js/133.4d7cdad5.js"><link rel="prefetch" href="/common/assets/js/134.175e14ba.js"><link rel="prefetch" href="/common/assets/js/135.6c143002.js"><link rel="prefetch" href="/common/assets/js/136.78afd8ff.js"><link rel="prefetch" href="/common/assets/js/137.347ff027.js"><link rel="prefetch" href="/common/assets/js/138.df837b4b.js"><link rel="prefetch" href="/common/assets/js/139.65c63374.js"><link rel="prefetch" href="/common/assets/js/14.cdf62cb8.js"><link rel="prefetch" href="/common/assets/js/140.51d65b0e.js"><link rel="prefetch" href="/common/assets/js/141.f9a51cbf.js"><link rel="prefetch" href="/common/assets/js/142.6d88dd71.js"><link rel="prefetch" href="/common/assets/js/143.4026d731.js"><link rel="prefetch" href="/common/assets/js/144.22f9176e.js"><link rel="prefetch" href="/common/assets/js/145.5b4bc4d5.js"><link rel="prefetch" href="/common/assets/js/146.af7eed4e.js"><link rel="prefetch" href="/common/assets/js/147.ee00a155.js"><link rel="prefetch" href="/common/assets/js/148.9f987a2b.js"><link rel="prefetch" href="/common/assets/js/149.cad6b842.js"><link rel="prefetch" href="/common/assets/js/15.06d67387.js"><link rel="prefetch" href="/common/assets/js/150.4fd1ea3a.js"><link rel="prefetch" href="/common/assets/js/151.07167f62.js"><link rel="prefetch" href="/common/assets/js/152.45295d3e.js"><link rel="prefetch" href="/common/assets/js/153.b09d25ec.js"><link rel="prefetch" href="/common/assets/js/154.dcf40e55.js"><link rel="prefetch" href="/common/assets/js/155.e8630fed.js"><link rel="prefetch" href="/common/assets/js/156.cd310ab3.js"><link rel="prefetch" href="/common/assets/js/157.fbb601cd.js"><link rel="prefetch" href="/common/assets/js/158.2d59a307.js"><link rel="prefetch" href="/common/assets/js/159.c5393dcf.js"><link rel="prefetch" href="/common/assets/js/16.f65ce986.js"><link rel="prefetch" href="/common/assets/js/160.9d78b704.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.6d8d5318.js"><link rel="prefetch" href="/common/assets/js/164.5c07ac11.js"><link rel="prefetch" href="/common/assets/js/165.3ea85802.js"><link rel="prefetch" href="/common/assets/js/166.e8c681e5.js"><link rel="prefetch" href="/common/assets/js/167.ba95f807.js"><link rel="prefetch" href="/common/assets/js/168.99af1574.js"><link rel="prefetch" href="/common/assets/js/169.3a3e8489.js"><link rel="prefetch" href="/common/assets/js/17.66687909.js"><link rel="prefetch" href="/common/assets/js/170.50e773a0.js"><link rel="prefetch" href="/common/assets/js/171.2c1f7987.js"><link rel="prefetch" href="/common/assets/js/172.d6fe72c8.js"><link rel="prefetch" href="/common/assets/js/173.fa8116ca.js"><link rel="prefetch" href="/common/assets/js/174.cd35051f.js"><link rel="prefetch" href="/common/assets/js/175.d225e122.js"><link rel="prefetch" href="/common/assets/js/176.037c9c6a.js"><link rel="prefetch" href="/common/assets/js/177.25bdd03b.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.d8e7daec.js"><link rel="prefetch" href="/common/assets/js/180.d0d7416a.js"><link rel="prefetch" href="/common/assets/js/181.265ffcde.js"><link rel="prefetch" href="/common/assets/js/182.17aac8ce.js"><link rel="prefetch" href="/common/assets/js/183.497b2283.js"><link rel="prefetch" href="/common/assets/js/184.478a891c.js"><link rel="prefetch" href="/common/assets/js/185.6c3879cf.js"><link rel="prefetch" href="/common/assets/js/186.77a23514.js"><link rel="prefetch" href="/common/assets/js/187.765f81a4.js"><link rel="prefetch" href="/common/assets/js/188.348a5174.js"><link rel="prefetch" href="/common/assets/js/189.68693ae1.js"><link rel="prefetch" href="/common/assets/js/19.abe0aba9.js"><link rel="prefetch" href="/common/assets/js/190.5992cf8d.js"><link rel="prefetch" href="/common/assets/js/191.9561b139.js"><link rel="prefetch" href="/common/assets/js/192.f7cb00e8.js"><link rel="prefetch" href="/common/assets/js/193.ec9dac13.js"><link rel="prefetch" href="/common/assets/js/194.91654e88.js"><link rel="prefetch" href="/common/assets/js/195.1089c5be.js"><link rel="prefetch" href="/common/assets/js/196.46524ef0.js"><link rel="prefetch" href="/common/assets/js/197.72ae4804.js"><link rel="prefetch" href="/common/assets/js/198.67fc5eb5.js"><link rel="prefetch" href="/common/assets/js/199.24cd895b.js"><link rel="prefetch" href="/common/assets/js/20.fec34c17.js"><link rel="prefetch" href="/common/assets/js/200.06ea278f.js"><link rel="prefetch" href="/common/assets/js/201.69833266.js"><link rel="prefetch" href="/common/assets/js/202.5eecc4e9.js"><link rel="prefetch" href="/common/assets/js/203.36b81107.js"><link rel="prefetch" href="/common/assets/js/204.d6cc92ca.js"><link rel="prefetch" href="/common/assets/js/205.b8a7e0cb.js"><link rel="prefetch" href="/common/assets/js/206.d65748de.js"><link rel="prefetch" href="/common/assets/js/207.27a83dc0.js"><link rel="prefetch" href="/common/assets/js/208.33c2f481.js"><link rel="prefetch" href="/common/assets/js/209.8498127e.js"><link rel="prefetch" href="/common/assets/js/21.33f3c84a.js"><link rel="prefetch" href="/common/assets/js/210.55deda89.js"><link rel="prefetch" href="/common/assets/js/211.7e86d5ba.js"><link rel="prefetch" href="/common/assets/js/212.d7390e95.js"><link rel="prefetch" href="/common/assets/js/213.693cbd68.js"><link rel="prefetch" href="/common/assets/js/214.b58aaf1c.js"><link rel="prefetch" href="/common/assets/js/215.b803123d.js"><link rel="prefetch" href="/common/assets/js/216.e6d7df8e.js"><link rel="prefetch" href="/common/assets/js/217.f1faffcf.js"><link rel="prefetch" href="/common/assets/js/218.b545b399.js"><link rel="prefetch" href="/common/assets/js/219.d691d2fa.js"><link rel="prefetch" href="/common/assets/js/22.b3e519f1.js"><link rel="prefetch" href="/common/assets/js/220.732ab40d.js"><link rel="prefetch" href="/common/assets/js/221.3ab0b29e.js"><link rel="prefetch" href="/common/assets/js/222.b6d99e16.js"><link rel="prefetch" href="/common/assets/js/223.f814013b.js"><link rel="prefetch" href="/common/assets/js/224.30f758f2.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.3374c974.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.67d69ce6.js"><link rel="prefetch" href="/common/assets/js/231.b3ed861d.js"><link rel="prefetch" href="/common/assets/js/232.67759a82.js"><link rel="prefetch" href="/common/assets/js/233.6411d217.js"><link rel="prefetch" href="/common/assets/js/234.215b2134.js"><link rel="prefetch" href="/common/assets/js/235.bb6bf091.js"><link rel="prefetch" href="/common/assets/js/236.a1743b72.js"><link rel="prefetch" href="/common/assets/js/237.cf91c6d9.js"><link rel="prefetch" href="/common/assets/js/238.daad0e47.js"><link rel="prefetch" href="/common/assets/js/239.140e9afc.js"><link rel="prefetch" href="/common/assets/js/24.cde54b27.js"><link rel="prefetch" href="/common/assets/js/240.4390c353.js"><link rel="prefetch" href="/common/assets/js/241.d3f5e4de.js"><link rel="prefetch" href="/common/assets/js/242.733a2eb7.js"><link rel="prefetch" href="/common/assets/js/243.d3bf27af.js"><link rel="prefetch" href="/common/assets/js/25.d80e6990.js"><link rel="prefetch" href="/common/assets/js/26.bce2e7e5.js"><link rel="prefetch" href="/common/assets/js/27.fc38d8b0.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.b1cd4b7f.js"><link rel="prefetch" href="/common/assets/js/32.c9b1699b.js"><link rel="prefetch" href="/common/assets/js/33.9cd88591.js"><link rel="prefetch" href="/common/assets/js/34.3626219a.js"><link rel="prefetch" href="/common/assets/js/35.895f12e2.js"><link rel="prefetch" href="/common/assets/js/36.e712ae96.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.eeddab89.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.e1f4f49a.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.07201cd3.js"><link rel="prefetch" href="/common/assets/js/53.95738ad9.js"><link rel="prefetch" href="/common/assets/js/54.36b1fbcd.js"><link rel="prefetch" href="/common/assets/js/55.210cf109.js"><link rel="prefetch" href="/common/assets/js/56.b9456f9c.js"><link rel="prefetch" href="/common/assets/js/57.541a883c.js"><link rel="prefetch" href="/common/assets/js/58.434d2ad0.js"><link rel="prefetch" href="/common/assets/js/59.dc6dac5c.js"><link rel="prefetch" href="/common/assets/js/6.4211a0b3.js"><link rel="prefetch" href="/common/assets/js/60.e830d4c9.js"><link rel="prefetch" href="/common/assets/js/61.a5c6d657.js"><link rel="prefetch" href="/common/assets/js/62.e1a3e089.js"><link rel="prefetch" href="/common/assets/js/63.44b784a4.js"><link rel="prefetch" href="/common/assets/js/64.0b302571.js"><link rel="prefetch" href="/common/assets/js/65.c59be25f.js"><link rel="prefetch" href="/common/assets/js/66.d89c854d.js"><link rel="prefetch" href="/common/assets/js/67.f1ea78fd.js"><link rel="prefetch" href="/common/assets/js/68.cc747b6b.js"><link rel="prefetch" href="/common/assets/js/69.a0aca143.js"><link rel="prefetch" href="/common/assets/js/7.9cff3c08.js"><link rel="prefetch" href="/common/assets/js/70.6aa525bb.js"><link rel="prefetch" href="/common/assets/js/71.83d894e0.js"><link rel="prefetch" href="/common/assets/js/72.2b075c81.js"><link rel="prefetch" href="/common/assets/js/73.89cc551f.js"><link rel="prefetch" href="/common/assets/js/74.0d118f78.js"><link rel="prefetch" href="/common/assets/js/75.11553212.js"><link rel="prefetch" href="/common/assets/js/76.5786ef1a.js"><link rel="prefetch" href="/common/assets/js/77.80b74117.js"><link rel="prefetch" href="/common/assets/js/78.ca222a4d.js"><link rel="prefetch" href="/common/assets/js/79.71ce2c6c.js"><link rel="prefetch" href="/common/assets/js/8.ee3a3ff3.js"><link rel="prefetch" href="/common/assets/js/80.c2f44ca3.js"><link rel="prefetch" href="/common/assets/js/81.8a7a630b.js"><link rel="prefetch" href="/common/assets/js/82.63a91c1f.js"><link rel="prefetch" href="/common/assets/js/83.ce3a21bb.js"><link rel="prefetch" href="/common/assets/js/84.30cc8514.js"><link rel="prefetch" href="/common/assets/js/85.d1539fa0.js"><link rel="prefetch" href="/common/assets/js/86.bf1809e4.js"><link rel="prefetch" href="/common/assets/js/87.c3880025.js"><link rel="prefetch" href="/common/assets/js/88.de0b3335.js"><link rel="prefetch" href="/common/assets/js/89.a73fda23.js"><link rel="prefetch" href="/common/assets/js/9.8b5d10b6.js"><link rel="prefetch" href="/common/assets/js/90.fc751a64.js"><link rel="prefetch" href="/common/assets/js/91.9a0c0b54.js"><link rel="prefetch" href="/common/assets/js/92.f45b658c.js"><link rel="prefetch" href="/common/assets/js/93.4228fc8d.js"><link rel="prefetch" href="/common/assets/js/94.6d5a907e.js"><link rel="prefetch" href="/common/assets/js/95.8c661080.js"><link rel="prefetch" href="/common/assets/js/96.be58a66c.js"><link rel="prefetch" href="/common/assets/js/97.7606a016.js"><link rel="prefetch" href="/common/assets/js/98.a559845e.js"><link rel="prefetch" href="/common/assets/js/99.c6bdd4ab.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> <p>. <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.
|
|
. <strong>Non-master branches</strong>, prefixed with a short name moniker (e.g. <code><initials>-<feature></code>) must be used for ongoing work.
|
|
. <strong>All modifications</strong> must be made in a <strong>pull-request</strong> to solicit feedback from other contributors.
|
|
. A pull-request <em>must not be merged until CI</em> has finished successfully.</p> <p>Merging pull requests once CI is successful:</p> <p>. 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.
|
|
. No PR should be merged until all reviews' comments are addressed.</p> <p>.Reviewing pull requests:
|
|
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> <p>. Buggy behaviour.
|
|
. Undue maintenance burden.
|
|
. Breaking with house coding style.
|
|
. Pessimisation (i.e. reduction of speed as measured in the projects benchmarks).
|
|
. Feature reduction (i.e. it removes some aspect of functionality that a significant minority of users rely on).
|
|
. Uselessness (i.e. it does not strictly add a feature or fix a known issue).</p> <p>.Reviews may not be used as an effective veto for a PR because:
|
|
. There exists a somewhat cleaner/better/faster way of accomplishing the same feature/fix.
|
|
. It does not fit well with some other contributors' longer-term vision for the project.</p> <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 "OPEN Open Source Project" guidelines for the Level project: https://github.com/Level/community/blob/master/CONTRIBUTING.md</p></div> <footer class="page-edit"><!----> <div class="last-updated"><span class="prefix">Last Updated: </span> <span class="time">2/13/2019, 4:38:56 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.1af07c41.js" defer></script><script src="/common/assets/js/2.91658b52.js" defer></script><script src="/common/assets/js/5.273314fb.js" defer></script>
|
|
</body>
|
|
</html>
|