mirror of
https://github.com/pezkuwichain/pezkuwi-ui.git
synced 2026-04-22 10:17:57 +00:00
Travis CI
27 lines
13 KiB
HTML
27 lines
13 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/ui</title>
|
|
<meta name="description" content="UI libraries and utilities in-use accross @polkadot projects">
|
|
|
|
|
|
<link rel="preload" href="/ui/assets/css/0.styles.f5c7dbec.css" as="style"><link rel="preload" href="/ui/assets/js/app.73634ed0.js" as="script"><link rel="preload" href="/ui/assets/js/2.f00ab508.js" as="script"><link rel="preload" href="/ui/assets/js/6.1cf8dc02.js" as="script"><link rel="prefetch" href="/ui/assets/js/10.feee2fb6.js"><link rel="prefetch" href="/ui/assets/js/11.4431186e.js"><link rel="prefetch" href="/ui/assets/js/12.60cde7c6.js"><link rel="prefetch" href="/ui/assets/js/13.e8f9b929.js"><link rel="prefetch" href="/ui/assets/js/14.edf23a0c.js"><link rel="prefetch" href="/ui/assets/js/15.6e140e5c.js"><link rel="prefetch" href="/ui/assets/js/16.814a59b4.js"><link rel="prefetch" href="/ui/assets/js/17.4319f57a.js"><link rel="prefetch" href="/ui/assets/js/18.00707b98.js"><link rel="prefetch" href="/ui/assets/js/19.0353e250.js"><link rel="prefetch" href="/ui/assets/js/20.f2154956.js"><link rel="prefetch" href="/ui/assets/js/21.d98322fa.js"><link rel="prefetch" href="/ui/assets/js/22.11f02f68.js"><link rel="prefetch" href="/ui/assets/js/23.7e342d4b.js"><link rel="prefetch" href="/ui/assets/js/24.09820451.js"><link rel="prefetch" href="/ui/assets/js/25.1bd9b377.js"><link rel="prefetch" href="/ui/assets/js/26.7b3990eb.js"><link rel="prefetch" href="/ui/assets/js/27.dd6dd743.js"><link rel="prefetch" href="/ui/assets/js/28.233b0f0a.js"><link rel="prefetch" href="/ui/assets/js/29.a6937576.js"><link rel="prefetch" href="/ui/assets/js/3.59687fa1.js"><link rel="prefetch" href="/ui/assets/js/30.328e9c48.js"><link rel="prefetch" href="/ui/assets/js/31.cb7914e9.js"><link rel="prefetch" href="/ui/assets/js/32.665882f2.js"><link rel="prefetch" href="/ui/assets/js/33.df108508.js"><link rel="prefetch" href="/ui/assets/js/34.b3c60c46.js"><link rel="prefetch" href="/ui/assets/js/35.29dac2f1.js"><link rel="prefetch" href="/ui/assets/js/36.21d292ef.js"><link rel="prefetch" href="/ui/assets/js/37.decf506d.js"><link rel="prefetch" href="/ui/assets/js/38.fa65c92d.js"><link rel="prefetch" href="/ui/assets/js/39.b67bc959.js"><link rel="prefetch" href="/ui/assets/js/4.7bd9f4a3.js"><link rel="prefetch" href="/ui/assets/js/40.eb2643d2.js"><link rel="prefetch" href="/ui/assets/js/41.9d7f2b1e.js"><link rel="prefetch" href="/ui/assets/js/42.ce9853f2.js"><link rel="prefetch" href="/ui/assets/js/43.ef18b427.js"><link rel="prefetch" href="/ui/assets/js/44.e0ccc5ab.js"><link rel="prefetch" href="/ui/assets/js/45.3b567ceb.js"><link rel="prefetch" href="/ui/assets/js/46.4d5b3c30.js"><link rel="prefetch" href="/ui/assets/js/47.887b39e7.js"><link rel="prefetch" href="/ui/assets/js/48.a3d06fb4.js"><link rel="prefetch" href="/ui/assets/js/49.7627fee6.js"><link rel="prefetch" href="/ui/assets/js/5.483bab38.js"><link rel="prefetch" href="/ui/assets/js/50.abd05e11.js"><link rel="prefetch" href="/ui/assets/js/51.3ec61dab.js"><link rel="prefetch" href="/ui/assets/js/52.2afa38a5.js"><link rel="prefetch" href="/ui/assets/js/53.f77215a0.js"><link rel="prefetch" href="/ui/assets/js/54.683fae75.js"><link rel="prefetch" href="/ui/assets/js/55.8b987b3e.js"><link rel="prefetch" href="/ui/assets/js/56.3403573d.js"><link rel="prefetch" href="/ui/assets/js/57.3a215b4a.js"><link rel="prefetch" href="/ui/assets/js/58.43ef2d75.js"><link rel="prefetch" href="/ui/assets/js/59.dc6b692e.js"><link rel="prefetch" href="/ui/assets/js/60.9121e16b.js"><link rel="prefetch" href="/ui/assets/js/61.fdb5b478.js"><link rel="prefetch" href="/ui/assets/js/62.3852ca62.js"><link rel="prefetch" href="/ui/assets/js/63.17c6de51.js"><link rel="prefetch" href="/ui/assets/js/64.53931fa1.js"><link rel="prefetch" href="/ui/assets/js/65.4a396d1b.js"><link rel="prefetch" href="/ui/assets/js/66.bdab91ca.js"><link rel="prefetch" href="/ui/assets/js/67.c5fc00e6.js"><link rel="prefetch" href="/ui/assets/js/68.8152528b.js"><link rel="prefetch" href="/ui/assets/js/7.b58d6c7e.js"><link rel="prefetch" href="/ui/assets/js/8.24fc59de.js"><link rel="prefetch" href="/ui/assets/js/9.0d2a08b3.js">
|
|
<link rel="stylesheet" href="/ui/assets/css/0.styles.f5c7dbec.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="/ui/" class="home-link router-link-active"><!----> <span class="site-name">polkadot-js/ui</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/ui" 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/ui" 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><a href="/ui/ui-identicon/" class="sidebar-link">@polkadot/ui-identicon</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/ui/ui-identicon/#usage-examples" class="sidebar-link">Usage Examples</a></li></ul></li><li><a href="/ui/ui-keyring/" class="sidebar-link">@polkadot/ui-keyring</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/ui/ui-keyring/#usage-examples" class="sidebar-link">Usage Examples</a></li><li class="sidebar-sub-header"><a href="/ui/ui-keyring/#observables" class="sidebar-link">Observables</a></li><li class="sidebar-sub-header"><a href="/ui/ui-keyring/#faq" class="sidebar-link">FAQ</a></li><li class="sidebar-sub-header"><a href="/ui/ui-keyring/#users" class="sidebar-link">Users</a></li></ul></li><li><a href="/ui/ui-settings/" class="sidebar-link">@polkadot/ui-settings</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/ui/ui-settings/#usage-examples" class="sidebar-link">Usage Examples</a></li><li class="sidebar-sub-header"><a href="/ui/ui-settings/#used-by" class="sidebar-link">Used by</a></li></ul></li><li><a href="/ui/ui-util/" class="sidebar-link">@polkadot/ui-util</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/ui/ui-util/#formatbalance" class="sidebar-link">formatBalance</a></li><li class="sidebar-sub-header"><a href="/ui/ui-util/#calcsi" class="sidebar-link">calcSi</a></li></ul></li><li><a href="/ui/CONTRIBUTING.html" class="active sidebar-link">Contributing</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/ui/CONTRIBUTING.html#what" class="sidebar-link">What?</a></li><li class="sidebar-sub-header"><a href="/ui/CONTRIBUTING.html#rules" class="sidebar-link">Rules</a></li><li class="sidebar-sub-header"><a href="/ui/CONTRIBUTING.html#releases" class="sidebar-link">Releases</a></li><li class="sidebar-sub-header"><a href="/ui/CONTRIBUTING.html#changes-to-this-arrangement" class="sidebar-link">Changes to this arrangement</a></li><li class="sidebar-sub-header"><a href="/ui/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"><!----> <div class="last-updated"><span class="prefix">Last Updated: </span> <span class="time">2/27/2019, 10:18:35 AM</span></div></footer> <div class="page-nav"><p class="inner"><span class="prev">
|
|
←
|
|
<a href="/ui/ui-util/" class="prev">
|
|
@polkadot/ui-util
|
|
</a></span> <!----></p></div> </main></div><div class="global-ui"></div></div>
|
|
<script src="/ui/assets/js/app.73634ed0.js" defer></script><script src="/ui/assets/js/2.f00ab508.js" defer></script><script src="/ui/assets/js/6.1cf8dc02.js" defer></script>
|
|
</body>
|
|
</html>
|