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://codeberg.org/bookstack/website).
   5
   6 ### Hack Update Service
   7
   8 As a way to sustainably maintain hacks, a hack update service is advertised on hack pages which allows people to pay a one-off fee to request an update of a hack to work with the latest release of BookStack.
   9 This service is provided by [HTTP Functions Ltd](https://www.httpfunctions.com/).
  10
  11 ### Support & Issues
  12
  13 Hacks in this repo are unsupported, maybe become out-of-date and do not receive active maintenance unlike the core BookStack codebase.
  14
  15 Feel free to raise an issue for bugs or incorrect content but **please do not open issues for**:
  16
  17 - Requesting new hacks, or variations of existing hacks.
  18 - Guidance/support for implementing, using or maintaining hacks.
  19 - Issues when using hacks on BookStack versions they're not lasted tested for.
  20 - Providing details to update a hack (Open a PR instead).
  21 - Limitations in existing hacks.
  22
  23 ### Contributions & Scope
  24
  25 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:
  26
  27 - There should be minimal overlap with an existing hack.
  28 - The hack should have a relatively minimal surface area.
  29 - The hack should have a reasonably low chance of conflicting with future updates.
  30 - The hack should have a low likelihood of inadvertently causing additional problems.
  31 - Hacks should not have external platform-specific requirements.
  32
  33 Pull requests to update hacks for more recent compatibility are welcome, as long as they don't apply additional non-required changes.
  34
  35 Contributions will become under the MIT license of the project.