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.e4a64be8.js" as="script"><link rel="preload" href="/common/assets/js/2.3cf4aef4.js" as="script"><link rel="preload" href="/common/assets/js/5.1b67dd1a.js" as="script"><link rel="prefetch" href="/common/assets/js/10.076b09ab.js"><link rel="prefetch" href="/common/assets/js/100.e4b5e4da.js"><link rel="prefetch" href="/common/assets/js/101.bd65c65f.js"><link rel="prefetch" href="/common/assets/js/102.bba977af.js"><link rel="prefetch" href="/common/assets/js/103.7e8ad41a.js"><link rel="prefetch" href="/common/assets/js/104.639dc79e.js"><link rel="prefetch" href="/common/assets/js/105.960a93d3.js"><link rel="prefetch" href="/common/assets/js/106.8f137891.js"><link rel="prefetch" href="/common/assets/js/107.536a8d2f.js"><link rel="prefetch" href="/common/assets/js/108.610e1ce1.js"><link rel="prefetch" href="/common/assets/js/109.11b7b55d.js"><link rel="prefetch" href="/common/assets/js/11.9dbe75e1.js"><link rel="prefetch" href="/common/assets/js/110.be875d25.js"><link rel="prefetch" href="/common/assets/js/111.62bf1e3d.js"><link rel="prefetch" href="/common/assets/js/112.a7cbe400.js"><link rel="prefetch" href="/common/assets/js/113.eb47034d.js"><link rel="prefetch" href="/common/assets/js/114.16bc8bbc.js"><link rel="prefetch" href="/common/assets/js/115.328d2603.js"><link rel="prefetch" href="/common/assets/js/116.2244012c.js"><link rel="prefetch" href="/common/assets/js/117.3a521383.js"><link rel="prefetch" href="/common/assets/js/118.d0946215.js"><link rel="prefetch" href="/common/assets/js/119.db831334.js"><link rel="prefetch" href="/common/assets/js/12.4cad32f0.js"><link rel="prefetch" href="/common/assets/js/120.88d79017.js"><link rel="prefetch" href="/common/assets/js/121.d986b84b.js"><link rel="prefetch" href="/common/assets/js/122.fb326421.js"><link rel="prefetch" href="/common/assets/js/123.fde1d3ce.js"><link rel="prefetch" href="/common/assets/js/124.415b36bc.js"><link rel="prefetch" href="/common/assets/js/125.4da37aaf.js"><link rel="prefetch" href="/common/assets/js/126.45d23ebf.js"><link rel="prefetch" href="/common/assets/js/127.579e9a52.js"><link rel="prefetch" href="/common/assets/js/128.96a9551e.js"><link rel="prefetch" href="/common/assets/js/129.a00b4179.js"><link rel="prefetch" href="/common/assets/js/13.cbb9d728.js"><link rel="prefetch" href="/common/assets/js/130.e191e69c.js"><link rel="prefetch" href="/common/assets/js/131.cf4e53d9.js"><link rel="prefetch" href="/common/assets/js/132.8db55985.js"><link rel="prefetch" href="/common/assets/js/133.f4d255a9.js"><link rel="prefetch" href="/common/assets/js/134.5c8d276f.js"><link rel="prefetch" href="/common/assets/js/135.e3e3ce9a.js"><link rel="prefetch" href="/common/assets/js/136.7d7a97ef.js"><link rel="prefetch" href="/common/assets/js/137.e910cb11.js"><link rel="prefetch" href="/common/assets/js/138.01d42ab8.js"><link rel="prefetch" href="/common/assets/js/139.020e7765.js"><link rel="prefetch" href="/common/assets/js/14.d911bc54.js"><link rel="prefetch" href="/common/assets/js/140.56a229f7.js"><link rel="prefetch" href="/common/assets/js/141.1d9ab190.js"><link rel="prefetch" href="/common/assets/js/142.46c77fd4.js"><link rel="prefetch" href="/common/assets/js/143.3d5763a4.js"><link rel="prefetch" href="/common/assets/js/144.1c39f76f.js"><link rel="prefetch" href="/common/assets/js/145.4217390e.js"><link rel="prefetch" href="/common/assets/js/146.76e0488e.js"><link rel="prefetch" href="/common/assets/js/147.db8fdb91.js"><link rel="prefetch" href="/common/assets/js/148.15d12ba1.js"><link rel="prefetch" href="/common/assets/js/149.ea44985f.js"><link rel="prefetch" href="/common/assets/js/15.91b8fb35.js"><link rel="prefetch" href="/common/assets/js/150.8a21af51.js"><link rel="prefetch" href="/common/assets/js/151.7c0964bb.js"><link rel="prefetch" href="/common/assets/js/152.a46bebca.js"><link rel="prefetch" href="/common/assets/js/153.8307c3ee.js"><link rel="prefetch" href="/common/assets/js/154.c77bbd22.js"><link rel="prefetch" href="/common/assets/js/155.68524be3.js"><link rel="prefetch" href="/common/assets/js/156.83f61c99.js"><link rel="prefetch" href="/common/assets/js/157.af70dd3a.js"><link rel="prefetch" href="/common/assets/js/158.75ddfdb1.js"><link rel="prefetch" href="/common/assets/js/159.047878c5.js"><link rel="prefetch" href="/common/assets/js/16.eb8da825.js"><link rel="prefetch" href="/common/assets/js/160.84bd0c66.js"><link rel="prefetch" href="/common/assets/js/161.9642f899.js"><link rel="prefetch" href="/common/assets/js/162.d00d3130.js"><link rel="prefetch" href="/common/assets/js/163.9def0883.js"><link rel="prefetch" href="/common/assets/js/164.d2fb7cc2.js"><link rel="prefetch" href="/common/assets/js/165.c99f3dd5.js"><link rel="prefetch" href="/common/assets/js/166.a5f6a19d.js"><link rel="prefetch" href="/common/assets/js/167.f201c902.js"><link rel="prefetch" href="/common/assets/js/168.2ada9767.js"><link rel="prefetch" href="/common/assets/js/169.7859e039.js"><link rel="prefetch" href="/common/assets/js/17.2566c5a3.js"><link rel="prefetch" href="/common/assets/js/170.8b62f553.js"><link rel="prefetch" href="/common/assets/js/171.cd07bfd2.js"><link rel="prefetch" href="/common/assets/js/172.b8319a37.js"><link rel="prefetch" href="/common/assets/js/173.107a3aca.js"><link rel="prefetch" href="/common/assets/js/174.3b3d7f11.js"><link rel="prefetch" href="/common/assets/js/175.bc501755.js"><link rel="prefetch" href="/common/assets/js/176.8127a634.js"><link rel="prefetch" href="/common/assets/js/177.740d9976.js"><link rel="prefetch" href="/common/assets/js/178.1ec8385d.js"><link rel="prefetch" href="/common/assets/js/179.676daffb.js"><link rel="prefetch" href="/common/assets/js/18.d2a1bd7e.js"><link rel="prefetch" href="/common/assets/js/180.ca73108c.js"><link rel="prefetch" href="/common/assets/js/181.0d33cc0d.js"><link rel="prefetch" href="/common/assets/js/182.6a4e4276.js"><link rel="prefetch" href="/common/assets/js/183.ba18fe05.js"><link rel="prefetch" href="/common/assets/js/184.99ca2631.js"><link rel="prefetch" href="/common/assets/js/185.b0c23328.js"><link rel="prefetch" href="/common/assets/js/186.acddc75a.js"><link rel="prefetch" href="/common/assets/js/187.e106b438.js"><link rel="prefetch" href="/common/assets/js/188.cb6e1df9.js"><link rel="prefetch" href="/common/assets/js/189.ed4e0a9f.js"><link rel="prefetch" href="/common/assets/js/19.ff33b553.js"><link rel="prefetch" href="/common/assets/js/190.9687d3b4.js"><link rel="prefetch" href="/common/assets/js/191.428366bc.js"><link rel="prefetch" href="/common/assets/js/192.8bec518e.js"><link rel="prefetch" href="/common/assets/js/193.56e21372.js"><link rel="prefetch" href="/common/assets/js/194.2de98778.js"><link rel="prefetch" href="/common/assets/js/195.a9c1ca80.js"><link rel="prefetch" href="/common/assets/js/196.8e8205bf.js"><link rel="prefetch" href="/common/assets/js/197.be13d332.js"><link rel="prefetch" href="/common/assets/js/198.3a67b097.js"><link rel="prefetch" href="/common/assets/js/199.6060b81d.js"><link rel="prefetch" href="/common/assets/js/20.a9529802.js"><link rel="prefetch" href="/common/assets/js/200.095308d7.js"><link rel="prefetch" href="/common/assets/js/201.2b30a492.js"><link rel="prefetch" href="/common/assets/js/202.33af972d.js"><link rel="prefetch" href="/common/assets/js/203.8f3ee81f.js"><link rel="prefetch" href="/common/assets/js/204.32a7a922.js"><link rel="prefetch" href="/common/assets/js/205.e52a8f81.js"><link rel="prefetch" href="/common/assets/js/206.945ff8d3.js"><link rel="prefetch" href="/common/assets/js/207.bdd6cfbc.js"><link rel="prefetch" href="/common/assets/js/208.9a5f917e.js"><link rel="prefetch" href="/common/assets/js/209.9ea48ca5.js"><link rel="prefetch" href="/common/assets/js/21.43e9683e.js"><link rel="prefetch" href="/common/assets/js/210.14a38c3d.js"><link rel="prefetch" href="/common/assets/js/211.25d21d01.js"><link rel="prefetch" href="/common/assets/js/212.de100fe5.js"><link rel="prefetch" href="/common/assets/js/213.c13f7178.js"><link rel="prefetch" href="/common/assets/js/214.16dbe25d.js"><link rel="prefetch" href="/common/assets/js/215.7a780e2c.js"><link rel="prefetch" href="/common/assets/js/216.7483e312.js"><link rel="prefetch" href="/common/assets/js/217.2ba4b09d.js"><link rel="prefetch" href="/common/assets/js/218.f67f3828.js"><link rel="prefetch" href="/common/assets/js/219.6f5400ee.js"><link rel="prefetch" href="/common/assets/js/22.0a6e58a8.js"><link rel="prefetch" href="/common/assets/js/220.32b65bfc.js"><link rel="prefetch" href="/common/assets/js/221.fbc8c833.js"><link rel="prefetch" href="/common/assets/js/222.5dbf477f.js"><link rel="prefetch" href="/common/assets/js/223.0a1710ba.js"><link rel="prefetch" href="/common/assets/js/224.857c348f.js"><link rel="prefetch" href="/common/assets/js/225.1785a998.js"><link rel="prefetch" href="/common/assets/js/226.4bfa391e.js"><link rel="prefetch" href="/common/assets/js/227.3e46472b.js"><link rel="prefetch" href="/common/assets/js/228.245af2cf.js"><link rel="prefetch" href="/common/assets/js/229.a340b842.js"><link rel="prefetch" href="/common/assets/js/23.5f72cbe0.js"><link rel="prefetch" href="/common/assets/js/230.a31fb3f9.js"><link rel="prefetch" href="/common/assets/js/231.e765000e.js"><link rel="prefetch" href="/common/assets/js/232.daaeb683.js"><link rel="prefetch" href="/common/assets/js/233.3984c7c6.js"><link rel="prefetch" href="/common/assets/js/234.f8aa8f59.js"><link rel="prefetch" href="/common/assets/js/235.c473a11e.js"><link rel="prefetch" href="/common/assets/js/236.152e78c6.js"><link rel="prefetch" href="/common/assets/js/237.a42eb797.js"><link rel="prefetch" href="/common/assets/js/238.22bbb702.js"><link rel="prefetch" href="/common/assets/js/239.c76fbf89.js"><link rel="prefetch" href="/common/assets/js/24.11c58b76.js"><link rel="prefetch" href="/common/assets/js/240.d3c7f2f3.js"><link rel="prefetch" href="/common/assets/js/241.146ca2c9.js"><link rel="prefetch" href="/common/assets/js/242.e6ba913c.js"><link rel="prefetch" href="/common/assets/js/243.a731ca12.js"><link rel="prefetch" href="/common/assets/js/244.7476afb0.js"><link rel="prefetch" href="/common/assets/js/245.da1ce299.js"><link rel="prefetch" href="/common/assets/js/246.2080385b.js"><link rel="prefetch" href="/common/assets/js/25.88d65a7a.js"><link rel="prefetch" href="/common/assets/js/26.a20152c6.js"><link rel="prefetch" href="/common/assets/js/27.5462a169.js"><link rel="prefetch" href="/common/assets/js/28.8cf0b80a.js"><link rel="prefetch" href="/common/assets/js/29.647aae5d.js"><link rel="prefetch" href="/common/assets/js/3.77e58581.js"><link rel="prefetch" href="/common/assets/js/30.b424b456.js"><link rel="prefetch" href="/common/assets/js/31.52b46b25.js"><link rel="prefetch" href="/common/assets/js/32.c47f4316.js"><link rel="prefetch" href="/common/assets/js/33.378e9f24.js"><link rel="prefetch" href="/common/assets/js/34.ca516d02.js"><link rel="prefetch" href="/common/assets/js/35.491f9606.js"><link rel="prefetch" href="/common/assets/js/36.ac104d26.js"><link rel="prefetch" href="/common/assets/js/37.820c77e8.js"><link rel="prefetch" href="/common/assets/js/38.8b8c96d4.js"><link rel="prefetch" href="/common/assets/js/39.091b0117.js"><link rel="prefetch" href="/common/assets/js/4.064238ac.js"><link rel="prefetch" href="/common/assets/js/40.1674cca1.js"><link rel="prefetch" href="/common/assets/js/41.68f4778d.js"><link rel="prefetch" href="/common/assets/js/42.1c0ff6d7.js"><link rel="prefetch" href="/common/assets/js/43.7589e745.js"><link rel="prefetch" href="/common/assets/js/44.4d265237.js"><link rel="prefetch" href="/common/assets/js/45.0ea7a184.js"><link rel="prefetch" href="/common/assets/js/46.4449edf2.js"><link rel="prefetch" href="/common/assets/js/47.a2c43525.js"><link rel="prefetch" href="/common/assets/js/48.193f1837.js"><link rel="prefetch" href="/common/assets/js/49.c2e49bff.js"><link rel="prefetch" href="/common/assets/js/50.08336993.js"><link rel="prefetch" href="/common/assets/js/51.057688b5.js"><link rel="prefetch" href="/common/assets/js/52.9cf0c118.js"><link rel="prefetch" href="/common/assets/js/53.f3007c90.js"><link rel="prefetch" href="/common/assets/js/54.1209c1d3.js"><link rel="prefetch" href="/common/assets/js/55.a7efe1d2.js"><link rel="prefetch" href="/common/assets/js/56.db7b79c1.js"><link rel="prefetch" href="/common/assets/js/57.9aebcb2b.js"><link rel="prefetch" href="/common/assets/js/58.38e0e5dc.js"><link rel="prefetch" href="/common/assets/js/59.bd320942.js"><link rel="prefetch" href="/common/assets/js/6.44a78d91.js"><link rel="prefetch" href="/common/assets/js/60.69090b01.js"><link rel="prefetch" href="/common/assets/js/61.24d5ef65.js"><link rel="prefetch" href="/common/assets/js/62.d74e329a.js"><link rel="prefetch" href="/common/assets/js/63.6ad4622d.js"><link rel="prefetch" href="/common/assets/js/64.bd548f32.js"><link rel="prefetch" href="/common/assets/js/65.cb3ba7dd.js"><link rel="prefetch" href="/common/assets/js/66.0b02f723.js"><link rel="prefetch" href="/common/assets/js/67.243d3e03.js"><link rel="prefetch" href="/common/assets/js/68.5adb2e27.js"><link rel="prefetch" href="/common/assets/js/69.f9cdb05d.js"><link rel="prefetch" href="/common/assets/js/7.48cdafff.js"><link rel="prefetch" href="/common/assets/js/70.91a69d09.js"><link rel="prefetch" href="/common/assets/js/71.6d236acb.js"><link rel="prefetch" href="/common/assets/js/72.92e4b84b.js"><link rel="prefetch" href="/common/assets/js/73.63c04c3a.js"><link rel="prefetch" href="/common/assets/js/74.79f34d45.js"><link rel="prefetch" href="/common/assets/js/75.5f99c42e.js"><link rel="prefetch" href="/common/assets/js/76.c1048e4e.js"><link rel="prefetch" href="/common/assets/js/77.e1c4cc5b.js"><link rel="prefetch" href="/common/assets/js/78.b3d3996c.js"><link rel="prefetch" href="/common/assets/js/79.1fcfba42.js"><link rel="prefetch" href="/common/assets/js/8.fefee077.js"><link rel="prefetch" href="/common/assets/js/80.0054d750.js"><link rel="prefetch" href="/common/assets/js/81.3523c41a.js"><link rel="prefetch" href="/common/assets/js/82.f8ad7ae7.js"><link rel="prefetch" href="/common/assets/js/83.72c8b598.js"><link rel="prefetch" href="/common/assets/js/84.c20cdbbf.js"><link rel="prefetch" href="/common/assets/js/85.fe3c8db9.js"><link rel="prefetch" href="/common/assets/js/86.b4d77702.js"><link rel="prefetch" href="/common/assets/js/87.cf84e26c.js"><link rel="prefetch" href="/common/assets/js/88.99225b90.js"><link rel="prefetch" href="/common/assets/js/89.a76bed92.js"><link rel="prefetch" href="/common/assets/js/9.2de93bea.js"><link rel="prefetch" href="/common/assets/js/90.49b50baa.js"><link rel="prefetch" href="/common/assets/js/91.ce579065.js"><link rel="prefetch" href="/common/assets/js/92.458d4d09.js"><link rel="prefetch" href="/common/assets/js/93.5c96cc76.js"><link rel="prefetch" href="/common/assets/js/94.d05fa49f.js"><link rel="prefetch" href="/common/assets/js/95.f10f021f.js"><link rel="prefetch" href="/common/assets/js/96.ddc7dd86.js"><link rel="prefetch" href="/common/assets/js/97.176087c6.js"><link rel="prefetch" href="/common/assets/js/98.d5cb2501.js"><link rel="prefetch" href="/common/assets/js/99.a38bdad4.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.e4a64be8.js" defer></script><script src="/common/assets/js/2.3cf4aef4.js" defer></script><script src="/common/assets/js/5.1b67dd1a.js" defer></script>
|
|
</body>
|
|
</html>
|