Getting-Started-With-ACPI/assets/js/27.239a168c.js

(window.webpackJsonp=window.webpackJsonp||[]).push([[27],{418:function(e,t,i){"use strict";i.r(t);var o=i(25),n=Object(o.a)({},(function(){var e=this,t=e.$createElement,i=e._self._c||t;return i("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[i("h1",{attrs:{id:"supporting-the-guides"}},[i("a",{staticClass:"header-anchor",attrs:{href:"#supporting-the-guides"}},[e._v("#")]),e._v(" Supporting the guides")]),e._v(" "),i("p",[i("strong",[e._v("Note")]),e._v(": This is a community run guide which is not officially endorsed by Acidanthera. Please do not bug Acidanthera with issues about this guide.")]),e._v(" "),i("p",[e._v("Want to help support the guide? Well there's some ways you can help!")]),e._v(" "),i("ul",[i("li",[i("RouterLink",{attrs:{to:"/CONTRIBUTING.html#contributing-via-issues"}},[e._v("Contributing via Issues")])],1),e._v(" "),i("li",[i("RouterLink",{attrs:{to:"/CONTRIBUTING.html#contributing-via-prs"}},[e._v("Contributing via PRs")])],1)]),e._v(" "),i("p",[e._v("Note: For those wanting to contribute financially, we seriously appreciate it but we're a non-profit organization. We do this to teach, not to make money. If you have some money left over we highly recommend donating it to a charity. "),i("a",{attrs:{href:"https://crohnsandcolitis.donorportal.ca/Donation/DonationDetails.aspx?L=en-CA&G=159&F=1097&T=GENER",target:"_blank",rel:"noopener noreferrer"}},[e._v("Crohn's and Colitis Canada"),i("OutboundLink")],1),e._v(" is one we recommend if you have none on mind.")]),e._v(" "),i("h2",{attrs:{id:"contributing-via-issues"}},[i("a",{staticClass:"header-anchor",attrs:{href:"#contributing-via-issues"}},[e._v("#")]),e._v(" Contributing via Issues")]),e._v(" "),i("p",[e._v("Contributing via Issues is pretty simple but there are some rules:")]),e._v(" "),i("ul",[i("li",[e._v("Keep issues tab dedicated to guides issues only, "),i("strong",[e._v("no personal hackintosh issues")]),e._v(". It is not a place to discuss installation issues.")]),e._v(" "),i("li",[e._v("If for a typo or better clarification, please indicate what page it was on. Would appreciate not going for a scavenger hunt on where these issues are.")])]),e._v(" "),i("p",[e._v("You can find the issues tab here: "),i("a",{attrs:{href:"https://github.com/dortania/Getting-Started-With-ACPI/issues",target:"_blank",rel:"noopener noreferrer"}},[e._v("Getting Started With ACPI Issues"),i("OutboundLink")],1)]),e._v(" "),i("h2",{attrs:{id:"contributing-via-prs"}},[i("a",{staticClass:"header-anchor",attrs:{href:"#contributing-via-prs"}},[e._v("#")]),e._v(" Contributing via PRs")]),e._v(" "),i("p",[e._v("Some guidelines when contributing via PRs:")]),e._v(" "),i("ul",[i("li",[e._v("Use your brain (please).")]),e._v(" "),i("li",[e._v("Proofread your submissions.")]),e._v(" "),i("li",[e._v("Pull Requests can be denied if we feel it does not fit or has inaccurate information. We will generally tell you why it is rejected though or ask for revisions.\n"),i("ul",[i("li",[e._v("We would also appreciate sources for any bigger commits to make it easier on us to verify the info your provide is valid")])])]),e._v(" "),i("li",[e._v("Images must be hosted locally in the repo under the "),i("code",[e._v("/images/")]),e._v(" folder")]),e._v(" "),i("li",[e._v("Your PR must be run through a markdown lint and have all issues fixed.")]),e._v(" "),i("li",[e._v('In general, try to avoid using "non-Acidanthera" tools when possible. Generally we want to avoid use of third-party tools  - though if it\'s impossible otherwise, then you can link it.\n'),i("ul",[i("li",[e._v("Tools explicitly banned:\n"),i("ul",[i("li",[e._v("UniBeast, MultiBeast and KextBeast\n"),i("ul",[i("li",[e._v("More info can be found here: "),i("a",{attrs:{href:"https://github.com/khronokernel/Tonymcx86-stance",target:"_blank",rel:"noopener noreferrer"}},[e._v("Tonymacx86-stance"),i("OutboundLink")],1)])])]),e._v(" "),i("li",[e._v("Transmac\n"),i("ul",[i("li",[e._v("Know for creating borked USB drives")])])]),e._v(" "),i("li",[e._v("Niresh Installers\n"),i("ul",[i("li",[e._v("We'd like to avoid piracy with the guides")])])])])])])])]),e._v(" "),i("h3",{attrs:{id:"how-to-contribute"}},[i("a",{staticClass:"header-anchor",attrs:{href:"#how-to-contribute"}},[e._v("#")]),e._v(" How to Contribute")]),e._v(" "),i("p",[e._v("Best way to test your commits and make sure they are formatted correctly is downloading "),i("code",[e._v("nodejs")]),e._v(" and "),i("code",[e._v("yarn")]),e._v(" then getting the VuePress and "),i("a",{attrs:{href:"https://github.com/igorshubovych/markdownlint-cli",target:"_blank",rel:"noopener noreferrer"}},[e._v("markdownlint-cli"),i("OutboundLink")],1),e._v(" tools. When you run "),i("code",[e._v("yarn dev")]),e._v(", it will set up a local webserver which you can connect to view the changes you made. "),i("code",[e._v("markdownlint *")]),e._v(" will throw any errors at you about formatting as well, and "),i("code",[e._v("markdownlint -f *")]),e._v(" will attempt to fix these.")]),e._v(" "),i("ul",[i("li",[i("a",{attrs:{href:"https://github.com/dortania/Getting-Started-With-ACPI/fork/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Fork this repo"),i("OutboundLink")],1)]),e._v(" "),i("li",[e._v("Install the required tools:\n"),i("ul",[i("li",[i("code",[e._v("brew install yarn")])]),e._v(" "),i("li",[i("code",[e._v("npm install -g markdownlint-cli")])])])]),e._v(" "),i("li",[e._v("Make your changes.")]),e._v(" "),i("li",[e._v("Build the site:\n"),i("ul",[i("li",[i("code",[e._v("yarn install")]),e._v(" (To install all the required plugins)")]),e._v(" "),i("li",[i("code",[e._v("yarn dev")]),e._v(" (Preview the site)\n"),i("ul",[i("li",[e._v("Can be found at "),i("code",[e._v("http://localhost:8080")])])])])])]),e._v(" "),i("li",[e._v("Check markdown format:\n"),i("ul",[i("li",[i("code",[e._v("markdownlint -f *")]),e._v(" (To fix any potential issues)")])])])]),e._v(" "),i("h3",{attrs:{id:"tips"}},[i("a",{staticClass:"header-anchor",attrs:{href:"#tips"}},[e._v("#")]),e._v(" Tips")]),e._v(" "),i("p",[e._v("Some tools that make contributing a bit easier:")]),e._v(" "),i("ul",[i("li",[i("a",{attrs:{href:"https://typora.io",target:"_blank",rel:"noopener noreferrer"}},[e._v("Typora"),i("OutboundLink")],1),e._v(" for real time markdown rendering.")]),e._v(" "),i("li",[i("a",{attrs:{href:"https://macromates.com",target:"_blank",rel:"noopener noreferrer"}},[e._v("TextMate"),i("OutboundLink")],1),e._v(" for easy and powerful mass find/replace.")]),e._v(" "),i("li",[i("a",{attrs:{href:"https://desktop.github.com",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github Desktop"),i("OutboundLink")],1),e._v(" for more user friendly GUI.")])])])}),[],!1,null,null,null);t.default=n.exports}}]);