BookStack Code Mirror - hacks/blob - readme.md

   1 # BookStack Hacks
   2
   3 This repository contains the hacks that are shown on the [/hacks part of the website](https://www.bookstackapp.com/hacks/). This is not a website in itself,
   4 but it designed to be a submodule within the `hacks/` directory of the [BookStack website repo](https://github.com/BookStackApp/website).
   5
   6 ### Support & Issues
   7
   8 Hacks in this repo are unsupported, maybe become out-of-date and do not receive active maintenance unlike the core BookStack codebase.
   9
  10 Feel free to raise an issue for bugs or incorrect content but **please do not open issues for**:
  11
  12 - Requesting new hacks, or variations of existing hacks.
  13 - Guidance/support for implementing, using or maintaining hacks.
  14 - Issues when using hacks on BookStack versions they're not lasted tested for.
  15 - Providing details to update a hack (Open a PR instead).
  16 - Limitations in existing hacks.
  17
  18 ### Contributions & Scope
  19
  20 Contributions are welcome to this repository but the scope for additions will be relatively strict to keep maintenance dept minimal. Please don't assume any customizations/hacks will be accepted here. The scope will be as follows:
  21
  22 - There should be minimal overlap with an existing hack.
  23 - The hack should have a relatively minimal surface area.
  24 - The hack should have a reasonably low chance of conflicting with future updates.
  25 - The hack should have a low likelihood of inadvertently causing additional problems.
  26 - Hacks should not have external platform-specific requirements.
  27
  28 Pull requests to update hacks for more recent compatibility are welcome, as long as they don't apply additional non-required changes.
  29
  30 Contributions will become under the MIT license of the project. Note that I may in the future monetize the supply, updating and tweaking of hacks in this repo.