27 lines
24 KiB
HTML
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.fb630121.css" as="style"><link rel="preload" href="/common/assets/js/app.053b5d27.js" as="script"><link rel="preload" href="/common/assets/js/2.021cb93f.js" as="script"><link rel="preload" href="/common/assets/js/5.67d8dd7a.js" as="script"><link rel="prefetch" href="/common/assets/js/10.03644fc4.js"><link rel="prefetch" href="/common/assets/js/100.a7012cab.js"><link rel="prefetch" href="/common/assets/js/101.f1dd3c3c.js"><link rel="prefetch" href="/common/assets/js/102.6201bf74.js"><link rel="prefetch" href="/common/assets/js/103.5b8d9973.js"><link rel="prefetch" href="/common/assets/js/104.07322e2d.js"><link rel="prefetch" href="/common/assets/js/105.2b91f4c4.js"><link rel="prefetch" href="/common/assets/js/106.fb0c2df3.js"><link rel="prefetch" href="/common/assets/js/107.05356455.js"><link rel="prefetch" href="/common/assets/js/108.9703102a.js"><link rel="prefetch" href="/common/assets/js/109.20c5b126.js"><link rel="prefetch" href="/common/assets/js/11.e04395c6.js"><link rel="prefetch" href="/common/assets/js/110.3030744f.js"><link rel="prefetch" href="/common/assets/js/111.f30fb099.js"><link rel="prefetch" href="/common/assets/js/112.cba1f3a0.js"><link rel="prefetch" href="/common/assets/js/113.1b4edb45.js"><link rel="prefetch" href="/common/assets/js/114.3fe49a0a.js"><link rel="prefetch" href="/common/assets/js/115.fb4f4617.js"><link rel="prefetch" href="/common/assets/js/116.786235f4.js"><link rel="prefetch" href="/common/assets/js/117.4dad74b4.js"><link rel="prefetch" href="/common/assets/js/118.fa535ef9.js"><link rel="prefetch" href="/common/assets/js/119.129e69ea.js"><link rel="prefetch" href="/common/assets/js/12.aa32c7d5.js"><link rel="prefetch" href="/common/assets/js/120.78db4bd8.js"><link rel="prefetch" href="/common/assets/js/121.057d14be.js"><link rel="prefetch" href="/common/assets/js/122.e19861b9.js"><link rel="prefetch" href="/common/assets/js/123.7aef3512.js"><link rel="prefetch" href="/common/assets/js/124.8d81080e.js"><link rel="prefetch" href="/common/assets/js/125.65180236.js"><link rel="prefetch" href="/common/assets/js/126.f0c96893.js"><link rel="prefetch" href="/common/assets/js/127.3b270775.js"><link rel="prefetch" href="/common/assets/js/128.710b9e1f.js"><link rel="prefetch" href="/common/assets/js/129.1390c290.js"><link rel="prefetch" href="/common/assets/js/13.4c8dafe6.js"><link rel="prefetch" href="/common/assets/js/130.7f7ddd09.js"><link rel="prefetch" href="/common/assets/js/131.3d7f9660.js"><link rel="prefetch" href="/common/assets/js/132.a5f0464b.js"><link rel="prefetch" href="/common/assets/js/133.fb601a38.js"><link rel="prefetch" href="/common/assets/js/134.b961b661.js"><link rel="prefetch" href="/common/assets/js/135.ac6a65a3.js"><link rel="prefetch" href="/common/assets/js/136.9e99c036.js"><link rel="prefetch" href="/common/assets/js/137.163f198b.js"><link rel="prefetch" href="/common/assets/js/138.d0dc03dc.js"><link rel="prefetch" href="/common/assets/js/139.42b8a282.js"><link rel="prefetch" href="/common/assets/js/14.9d45f9fd.js"><link rel="prefetch" href="/common/assets/js/140.542e0060.js"><link rel="prefetch" href="/common/assets/js/141.200532cc.js"><link rel="prefetch" href="/common/assets/js/142.90ae389b.js"><link rel="prefetch" href="/common/assets/js/143.6f2d244d.js"><link rel="prefetch" href="/common/assets/js/144.e5720234.js"><link rel="prefetch" href="/common/assets/js/145.94e60c33.js"><link rel="prefetch" href="/common/assets/js/146.4bab20c2.js"><link rel="prefetch" href="/common/assets/js/147.d20c5a3c.js"><link rel="prefetch" href="/common/assets/js/148.aa7f09f2.js"><link rel="prefetch" href="/common/assets/js/149.b98d4c51.js"><link rel="prefetch" href="/common/assets/js/15.07dbab5d.js"><link rel="prefetch" href="/common/assets/js/150.01745cef.js"><link rel="prefetch" href="/common/assets/js/151.663e0cb7.js"><link rel="prefetch" href="/common/assets/js/152.6b55244c.js"><link rel="prefetch" href="/common/assets/js/153.ae82c2a5.js"><link rel="prefetch" href="/common/assets/js/154.49974e9b.js"><link rel="prefetch" href="/common/assets/js/155.37ca2c16.js"><link rel="prefetch" href="/common/assets/js/156.cbfc99fc.js"><link rel="prefetch" href="/common/assets/js/157.43cbf397.js"><link rel="prefetch" href="/common/assets/js/158.7a876643.js"><link rel="prefetch" href="/common/assets/js/159.a1961a5a.js"><link rel="prefetch" href="/common/assets/js/16.2ab5bf88.js"><link rel="prefetch" href="/common/assets/js/160.e0647591.js"><link rel="prefetch" href="/common/assets/js/161.511290f2.js"><link rel="prefetch" href="/common/assets/js/162.9074ef6a.js"><link rel="prefetch" href="/common/assets/js/163.84ed9249.js"><link rel="prefetch" href="/common/assets/js/164.fcdfc003.js"><link rel="prefetch" href="/common/assets/js/165.0765373d.js"><link rel="prefetch" href="/common/assets/js/166.d3ceaa8f.js"><link rel="prefetch" href="/common/assets/js/167.0dcda6ad.js"><link rel="prefetch" href="/common/assets/js/168.8fde22ef.js"><link rel="prefetch" href="/common/assets/js/169.1cf43a1c.js"><link rel="prefetch" href="/common/assets/js/17.aef32e36.js"><link rel="prefetch" href="/common/assets/js/170.b451fecd.js"><link rel="prefetch" href="/common/assets/js/171.918a435c.js"><link rel="prefetch" href="/common/assets/js/172.c4bc4c9d.js"><link rel="prefetch" href="/common/assets/js/173.8abaab2a.js"><link rel="prefetch" href="/common/assets/js/174.523116da.js"><link rel="prefetch" href="/common/assets/js/175.262d5afb.js"><link rel="prefetch" href="/common/assets/js/176.fb49a985.js"><link rel="prefetch" href="/common/assets/js/177.14ca17bf.js"><link rel="prefetch" href="/common/assets/js/178.76009c62.js"><link rel="prefetch" href="/common/assets/js/179.f6045035.js"><link rel="prefetch" href="/common/assets/js/18.7ed37a92.js"><link rel="prefetch" href="/common/assets/js/180.9922318c.js"><link rel="prefetch" href="/common/assets/js/181.34ca7172.js"><link rel="prefetch" href="/common/assets/js/182.36b1e610.js"><link rel="prefetch" href="/common/assets/js/183.e7d92210.js"><link rel="prefetch" href="/common/assets/js/184.51016fd9.js"><link rel="prefetch" href="/common/assets/js/185.1739802f.js"><link rel="prefetch" href="/common/assets/js/186.eeec7b40.js"><link rel="prefetch" href="/common/assets/js/187.17b4097b.js"><link rel="prefetch" href="/common/assets/js/188.b0e74cd8.js"><link rel="prefetch" href="/common/assets/js/189.c454ee9c.js"><link rel="prefetch" href="/common/assets/js/19.c330f4e2.js"><link rel="prefetch" href="/common/assets/js/190.a34015ca.js"><link rel="prefetch" href="/common/assets/js/191.c7ff8f3c.js"><link rel="prefetch" href="/common/assets/js/192.25bd80f9.js"><link rel="prefetch" href="/common/assets/js/193.a5365578.js"><link rel="prefetch" href="/common/assets/js/194.1fa73bd6.js"><link rel="prefetch" href="/common/assets/js/195.c36dd492.js"><link rel="prefetch" href="/common/assets/js/196.042e2176.js"><link rel="prefetch" href="/common/assets/js/197.0bfcbc88.js"><link rel="prefetch" href="/common/assets/js/198.63824938.js"><link rel="prefetch" href="/common/assets/js/199.3a2b200e.js"><link rel="prefetch" href="/common/assets/js/20.9dfd5ad3.js"><link rel="prefetch" href="/common/assets/js/200.1be2cb21.js"><link rel="prefetch" href="/common/assets/js/201.9e860676.js"><link rel="prefetch" href="/common/assets/js/202.035f5435.js"><link rel="prefetch" href="/common/assets/js/203.9d185bd4.js"><link rel="prefetch" href="/common/assets/js/204.dfe139f2.js"><link rel="prefetch" href="/common/assets/js/205.a48461b3.js"><link rel="prefetch" href="/common/assets/js/206.81cc4b83.js"><link rel="prefetch" href="/common/assets/js/207.4e13054f.js"><link rel="prefetch" href="/common/assets/js/208.d52ba5d2.js"><link rel="prefetch" href="/common/assets/js/209.d92676e1.js"><link rel="prefetch" href="/common/assets/js/21.811f521a.js"><link rel="prefetch" href="/common/assets/js/210.15d4f38c.js"><link rel="prefetch" href="/common/assets/js/211.fba46589.js"><link rel="prefetch" href="/common/assets/js/212.bf331e9c.js"><link rel="prefetch" href="/common/assets/js/213.da9f16bf.js"><link rel="prefetch" href="/common/assets/js/214.e08ad167.js"><link rel="prefetch" href="/common/assets/js/215.e3080622.js"><link rel="prefetch" href="/common/assets/js/216.9f5ae2d9.js"><link rel="prefetch" href="/common/assets/js/217.44cd8ce4.js"><link rel="prefetch" href="/common/assets/js/218.76dc3207.js"><link rel="prefetch" href="/common/assets/js/219.07e996c9.js"><link rel="prefetch" href="/common/assets/js/22.cb60742c.js"><link rel="prefetch" href="/common/assets/js/220.99e24b6c.js"><link rel="prefetch" href="/common/assets/js/221.c0a36ea5.js"><link rel="prefetch" href="/common/assets/js/222.0019d032.js"><link rel="prefetch" href="/common/assets/js/223.88da44ae.js"><link rel="prefetch" href="/common/assets/js/224.8d37e11d.js"><link rel="prefetch" href="/common/assets/js/225.ff93bfe6.js"><link rel="prefetch" href="/common/assets/js/226.53fb2fd2.js"><link rel="prefetch" href="/common/assets/js/227.fb414f11.js"><link rel="prefetch" href="/common/assets/js/228.2898112f.js"><link rel="prefetch" href="/common/assets/js/229.78767f02.js"><link rel="prefetch" href="/common/assets/js/23.8bd869a2.js"><link rel="prefetch" href="/common/assets/js/230.f68d8d34.js"><link rel="prefetch" href="/common/assets/js/231.af3f4b78.js"><link rel="prefetch" href="/common/assets/js/232.c4810066.js"><link rel="prefetch" href="/common/assets/js/233.abf1b8f4.js"><link rel="prefetch" href="/common/assets/js/234.93dce8c0.js"><link rel="prefetch" href="/common/assets/js/235.e804afea.js"><link rel="prefetch" href="/common/assets/js/236.eff48864.js"><link rel="prefetch" href="/common/assets/js/237.34ee85b0.js"><link rel="prefetch" href="/common/assets/js/238.c764e825.js"><link rel="prefetch" href="/common/assets/js/239.b039caba.js"><link rel="prefetch" href="/common/assets/js/24.018832c5.js"><link rel="prefetch" href="/common/assets/js/240.c80c8ba0.js"><link rel="prefetch" href="/common/assets/js/241.79f79135.js"><link rel="prefetch" href="/common/assets/js/242.bb8c6ee7.js"><link rel="prefetch" href="/common/assets/js/243.d3bf27af.js"><link rel="prefetch" href="/common/assets/js/25.fb601505.js"><link rel="prefetch" href="/common/assets/js/26.8f232672.js"><link rel="prefetch" href="/common/assets/js/27.ffe4c87e.js"><link rel="prefetch" href="/common/assets/js/28.a6582117.js"><link rel="prefetch" href="/common/assets/js/29.bdbd2be9.js"><link rel="prefetch" href="/common/assets/js/3.927f0a66.js"><link rel="prefetch" href="/common/assets/js/30.4c0d3262.js"><link rel="prefetch" href="/common/assets/js/31.466582eb.js"><link rel="prefetch" href="/common/assets/js/32.b2ae0974.js"><link rel="prefetch" href="/common/assets/js/33.b0ed970c.js"><link rel="prefetch" href="/common/assets/js/34.6e1dd63b.js"><link rel="prefetch" href="/common/assets/js/35.ef356935.js"><link rel="prefetch" href="/common/assets/js/36.654c87d1.js"><link rel="prefetch" href="/common/assets/js/37.1d01e380.js"><link rel="prefetch" href="/common/assets/js/38.ecb9feee.js"><link rel="prefetch" href="/common/assets/js/39.ee091fc5.js"><link rel="prefetch" href="/common/assets/js/4.adbf2d29.js"><link rel="prefetch" href="/common/assets/js/40.74733262.js"><link rel="prefetch" href="/common/assets/js/41.134c237b.js"><link rel="prefetch" href="/common/assets/js/42.4f1b707f.js"><link rel="prefetch" href="/common/assets/js/43.a37f5b1a.js"><link rel="prefetch" href="/common/assets/js/44.3333817e.js"><link rel="prefetch" href="/common/assets/js/45.0a082679.js"><link rel="prefetch" href="/common/assets/js/46.6b59aed9.js"><link rel="prefetch" href="/common/assets/js/47.c33cb1ca.js"><link rel="prefetch" href="/common/assets/js/48.2b2a706a.js"><link rel="prefetch" href="/common/assets/js/49.160d6d90.js"><link rel="prefetch" href="/common/assets/js/50.6025f82a.js"><link rel="prefetch" href="/common/assets/js/51.7e05055a.js"><link rel="prefetch" href="/common/assets/js/52.48a39845.js"><link rel="prefetch" href="/common/assets/js/53.928f4e7a.js"><link rel="prefetch" href="/common/assets/js/54.d5d7248c.js"><link rel="prefetch" href="/common/assets/js/55.eb4bae46.js"><link rel="prefetch" href="/common/assets/js/56.2ed1cbd9.js"><link rel="prefetch" href="/common/assets/js/57.f97ea590.js"><link rel="prefetch" href="/common/assets/js/58.5af2c64c.js"><link rel="prefetch" href="/common/assets/js/59.4762d9db.js"><link rel="prefetch" href="/common/assets/js/6.f84f7f1e.js"><link rel="prefetch" href="/common/assets/js/60.b4688065.js"><link rel="prefetch" href="/common/assets/js/61.792265be.js"><link rel="prefetch" href="/common/assets/js/62.93d9b6e0.js"><link rel="prefetch" href="/common/assets/js/63.c252a0c4.js"><link rel="prefetch" href="/common/assets/js/64.d97796f9.js"><link rel="prefetch" href="/common/assets/js/65.5211f6db.js"><link rel="prefetch" href="/common/assets/js/66.78279346.js"><link rel="prefetch" href="/common/assets/js/67.69290068.js"><link rel="prefetch" href="/common/assets/js/68.1903476b.js"><link rel="prefetch" href="/common/assets/js/69.4bda41ed.js"><link rel="prefetch" href="/common/assets/js/7.d7960391.js"><link rel="prefetch" href="/common/assets/js/70.a0101ace.js"><link rel="prefetch" href="/common/assets/js/71.a434d6e0.js"><link rel="prefetch" href="/common/assets/js/72.906f1d50.js"><link rel="prefetch" href="/common/assets/js/73.c08e8d28.js"><link rel="prefetch" href="/common/assets/js/74.c6d92619.js"><link rel="prefetch" href="/common/assets/js/75.bfd2e7e6.js"><link rel="prefetch" href="/common/assets/js/76.e136f70b.js"><link rel="prefetch" href="/common/assets/js/77.34c67145.js"><link rel="prefetch" href="/common/assets/js/78.9c8b3b59.js"><link rel="prefetch" href="/common/assets/js/79.0afadedd.js"><link rel="prefetch" href="/common/assets/js/8.556bb1f3.js"><link rel="prefetch" href="/common/assets/js/80.ad89b7d5.js"><link rel="prefetch" href="/common/assets/js/81.53bf2362.js"><link rel="prefetch" href="/common/assets/js/82.14299426.js"><link rel="prefetch" href="/common/assets/js/83.246037a2.js"><link rel="prefetch" href="/common/assets/js/84.58a27db5.js"><link rel="prefetch" href="/common/assets/js/85.45f4dfa2.js"><link rel="prefetch" href="/common/assets/js/86.8eb5d190.js"><link rel="prefetch" href="/common/assets/js/87.b9dc3769.js"><link rel="prefetch" href="/common/assets/js/88.283380f0.js"><link rel="prefetch" href="/common/assets/js/89.dcc98ad7.js"><link rel="prefetch" href="/common/assets/js/9.db11eaa2.js"><link rel="prefetch" href="/common/assets/js/90.76131e0b.js"><link rel="prefetch" href="/common/assets/js/91.d838a468.js"><link rel="prefetch" href="/common/assets/js/92.31419b13.js"><link rel="prefetch" href="/common/assets/js/93.9394eeaf.js"><link rel="prefetch" href="/common/assets/js/94.d6477679.js"><link rel="prefetch" href="/common/assets/js/95.1e7754a6.js"><link rel="prefetch" href="/common/assets/js/96.876511c8.js"><link rel="prefetch" href="/common/assets/js/97.6abca9bf.js"><link rel="prefetch" href="/common/assets/js/98.69f342c2.js"><link rel="prefetch" href="/common/assets/js/99.34561e06.js">
|
|
<link rel="stylesheet" href="/common/assets/css/0.styles.fb630121.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><initials>-<feature></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 "OPEN Open Source Project" 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"><!----> <!----></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.053b5d27.js" defer></script><script src="/common/assets/js/2.021cb93f.js" defer></script><script src="/common/assets/js/5.67d8dd7a.js" defer></script>
|
|
</body>
|
|
</html>
|