miguel456/athenahr
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore(readme): add readme w/ known caveats

Browse Source
This commit is contained in:
Miguel Nogueira 2023-06-28 10:55:33 +00:00
parent 8a39ba96e7
commit 43dab51e3b
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -1,4 +1,3 @@
# RBRecruiter v1.0.2-stable - Integrated Human Resources Management System # RBRecruiter v1.0.2-stable - Integrated Human Resources Management System
**Are the big name HR apps too bloated and overkill for your online community? Check RBRecruiter out to see if its right for you!** **Are the big name HR apps too bloated and overkill for your online community? Check RBRecruiter out to see if its right for you!**
@ -42,6 +41,18 @@ Tech stack:
- [jQuery](https://jquery.com/) - [jQuery](https://jquery.com/)
- [Icons by FontAwesome](https://fontawesome.com/) - [Icons by FontAwesome](https://fontawesome.com/)
# Known caveats
**Incompatible PHP extensions**
The following PHP extensions are known to cause problems throughout the app (resulting in numerous errors):
- [PHP PSR - PSR Interfaces](https://pecl.php.net/package/psr)
This is because the extension conflicts with a package Laravel uses, [Monolog](https://github.com/Seldaek/monolog), which is required for logging across the whole application. Oftentimes, removing this extension with your system's package manager or disabling it in ``php.ini`` does the trick and gets things to work again.
*This issue should not affect versions below 1.0.0.*
# Stability # Stability
At the moment, each new feature goes into its separate branch so that ``main`` remains stable. When the features being worked on are ready and tested, they are merged onto ``main``, and a new release can be started. The main branch is write-protected. At the moment, each new feature goes into its separate branch so that ``main`` remains stable. When the features being worked on are ready and tested, they are merged onto ``main``, and a new release can be started. The main branch is write-protected.