++Last modified: Sun Apr 26 2020 03:05:41 GMT+0000 (Coordinated Universal Time)
+
Supporting the guides
+Note: This is a community run guide which is not officially endorsed by Acidanthera. Please do not bug Acidanthera with issues about this guide.
+Want to help support the guide? Well there's some ways you can help!
+ +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. Crohn's and Colitis Canada is one we recommend if you have none on mind.
+Contributing via Issues
+Contributing via Issues is pretty simple but there are some rules:
+-
+
- Keep issues tab dedicated to guides issues only, no personal hackintosh issues. It is not a place to discuss installation issues. +
- 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. +
You can find the issues tab here: Getting Started With ACPI Issues
+Contributing via PRs
+Some guidelines when contributing via PRs:
+-
+
- Use your brain (please). +
- Proofread your submissions. +
- 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.
-
+
- We would also appreciate sources for any bigger commits to make it easier on us to verify the info your provide is valid +
+ - Images must be hosted locally in the repo under the
/images/folder
+ - Your PR must be run through a markdown lint and have all issues fixed. +
- 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.
-
+
- Tools explicitly banned:
-
+
- UniBeast, MultiBeast and KextBeast
-
+
- More info can be found here: Tonymacx86-stance +
+ - Transmac
-
+
- Know for creating borked USB drives +
+ - Niresh Installers
-
+
- We'd like to avoid piracy with the guides +
+
+ - UniBeast, MultiBeast and KextBeast
+ - Tools explicitly banned:
How to Contribute
+Best way to test your commits and make sure they are formatted correctly is downloading nodejs and getting the gitbook-cli and markdownlint-cli tools. When you run gitbook serve, it will set up a local webserver which you can connect to view the changes you made. markdownlint * will throw any errors at you about formatting as well, and markdownlint -f * will attempt to fix these.
-
+
- Fork this repo +
- Install the required tools:
-
+
npm install -g markdownlint-cli
+npm install -g gitbook-cli
+
+ - Make your changes. +
- Build the site:
-
+
gitbook install(To install all the required gitbook plugins)
+gitbook serve(Preview the site)-
+
- Can be found at
http://localhost:4000
+
+- Can be found at
+ - Check markdown format:
-
+
markdownlint -f *(To fix any potential issues)
+
+
Tips
+Some tools that make contributing a bit easier:
+-
+
- Typora for real time markdown rendering. +
- TextMate for easy and powerful mass find/replace. +
- Github Desktop for more user friendly GUI. +
