codinginbarn/bookstack-hacks
Fork 0
forked from bookstack/hacks
Code Pull requests Activity

Added funding and readme files

Browse source
This commit is contained in:
Dan Brown 2023-02-12 23:35:18 +00:00
commit 069b776e8d
Signed by: danb
GPG key ID: 46D9F943C24A2EF9
2 changed files with 34 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

4
.github/FUNDING.yml vendored Normal file
View file

@ -0,0 +1,4 @@
# These are supported funding model platforms
github: [ssddanbrown]
ko_fi: ssddanbrown

30
readme.md Normal file
View file

@ -0,0 +1,30 @@
# BookStack Hacks
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,
but it designed to be a submodule within the `hacks/` directory of the [BookStack website repo](https://github.com/BookStackApp/website).
### Support & Issues
Hacks in this repo are unsupported, maybe become out-of-date and do not receive active maintenance unlike the core BookStack codebase.
Feel free to raise an issue for bugs or incorrect content but **please do not open issues for**:
- Requesting new hacks, or variations of existing hacks.
- Guidance/support for implementing, using or maintaining hacks.
- Issues when using hacks on BookStack versions they're not lasted tested for.
- Providing details to update a hack (Open a PR instead).
- Limitations in existing hacks.
### Contributions & Scope
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:
- There should be minimal overlap with an existing hack.
- The hack should have a relatively minimal surface area.
- The hack should have a reasonably low chance of conflicting with future updates.
- The hack should have a low likelihood of inadvertently causing additional problems.
- Hacks should not have external platform-specific requirements.
Pull requests to update hacks for more recent compatibility are welcome, as long as they don't apply additional non-required changes.
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.