1 line
4.8 KiB
JavaScript
1 line
4.8 KiB
JavaScript
(window.webpackJsonp=window.webpackJsonp||[]).push([[5],{336:function(e,t,s){"use strict";s.r(t);var r=s(46),a=Object(r.a)({},function(){var e=this,t=e.$createElement,s=e._self._c||t;return s("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[s("h1",{attrs:{id:"contributing"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#contributing","aria-hidden":"true"}},[e._v("#")]),e._v(" Contributing")]),e._v(" "),s("h2",{attrs:{id:"what"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#what","aria-hidden":"true"}},[e._v("#")]),e._v(" What?")]),e._v(" "),s("p",[e._v("Individuals making significant and valuable contributions are given commit-access to a project to contribute as they see fit.\nA project is more like an open wiki than a standard guarded open source project.")]),e._v(" "),s("h2",{attrs:{id:"rules"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#rules","aria-hidden":"true"}},[e._v("#")]),e._v(" Rules")]),e._v(" "),s("p",[e._v("There are a few basic ground-rules for contributors (including the maintainer(s) of the project):")]),e._v(" "),s("ol",[s("li",[s("strong",[e._v("No "),s("code",[e._v("--force")]),e._v(" pushes")]),e._v(" or modifying the Git history in any way. If you need to rebase, ensure you do it in your own repo.")]),e._v(" "),s("li",[s("strong",[e._v("Non-master branches")]),e._v(", prefixed with a short name moniker (e.g. "),s("code",[e._v("<initials>-<feature>")]),e._v(") must be used for ongoing work.")]),e._v(" "),s("li",[s("strong",[e._v("All modifications")]),e._v(" must be made in a "),s("strong",[e._v("pull-request")]),e._v(" to solicit feedback from other contributors.")]),e._v(" "),s("li",[e._v("A pull-request "),s("em",[e._v("must not be merged until CI")]),e._v(" has finished successfully.")])]),e._v(" "),s("h4",{attrs:{id:"merging-pull-requests-once-ci-is-successful"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#merging-pull-requests-once-ci-is-successful","aria-hidden":"true"}},[e._v("#")]),e._v(" Merging pull requests once CI is successful:")]),e._v(" "),s("ul",[s("li",[e._v("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.")]),e._v(" "),s("li",[e._v("No PR should be merged until all reviews' comments are addressed.")])]),e._v(" "),s("h4",{attrs:{id:"reviewing-pull-requests"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#reviewing-pull-requests","aria-hidden":"true"}},[e._v("#")]),e._v(" Reviewing pull requests:")]),e._v(" "),s("p",[e._v("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:")]),e._v(" "),s("ul",[s("li",[e._v("Buggy behaviour.")]),e._v(" "),s("li",[e._v("Undue maintenance burden.")]),e._v(" "),s("li",[e._v("Breaking with house coding style.")]),e._v(" "),s("li",[e._v("Pessimisation (i.e. reduction of speed as measured in the projects benchmarks).")]),e._v(" "),s("li",[e._v("Feature reduction (i.e. it removes some aspect of functionality that a significant minority of users rely on).")]),e._v(" "),s("li",[e._v("Uselessness (i.e. it does not strictly add a feature or fix a known issue).")])]),e._v(" "),s("h4",{attrs:{id:"reviews-may-not-be-used-as-an-effective-veto-for-a-pr-because"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#reviews-may-not-be-used-as-an-effective-veto-for-a-pr-because","aria-hidden":"true"}},[e._v("#")]),e._v(" Reviews may not be used as an effective veto for a PR because:")]),e._v(" "),s("ul",[s("li",[e._v("There exists a somewhat cleaner/better/faster way of accomplishing the same feature/fix.")]),e._v(" "),s("li",[e._v("It does not fit well with some other contributors' longer-term vision for the project.")])]),e._v(" "),s("h2",{attrs:{id:"releases"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#releases","aria-hidden":"true"}},[e._v("#")]),e._v(" Releases")]),e._v(" "),s("p",[e._v("Declaring formal releases remains the prerogative of the project maintainer(s).")]),e._v(" "),s("h2",{attrs:{id:"changes-to-this-arrangement"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#changes-to-this-arrangement","aria-hidden":"true"}},[e._v("#")]),e._v(" Changes to this arrangement")]),e._v(" "),s("p",[e._v("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.")]),e._v(" "),s("h2",{attrs:{id:"heritage"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#heritage","aria-hidden":"true"}},[e._v("#")]),e._v(" Heritage")]),e._v(" "),s("p",[e._v('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')])])},[],!1,null,null,null);t.default=a.exports}}]); |