Thank you for considering to contribute to the rexify.org website!
For optimal workflow and experience, please follow the guidelines summarized in this document.
If you need help or have questions, please use our main support channels for both community and commercial support, or start a discussion.
Please use GitHub issues for bug reports and feature requests only.
Open GitHub issues to start discussing bugs or improvement ideas before proposing a specific implementation via pull requests.
Use draft pull requests share the details of a specific implementation proposal and ask for early feedback if needed.
To work with the website locally, clone the repo and use the following steps:
-
Install dependencies
cpanm --installdeps --with-develop .
-
Change something
-
Build site and start a local web server:
statocles -l daemon
-
Open the site at the printed address (e.g. http://0.0.0.0:3000)
Various Statocles plugins are checking for valid links and correct HTML during build time. To check locally, run:
statocles -l build
The build and deploy GitHub Actions workflow runs the same tests for pull requests and branch changes.
The default branch is continuously deployed to GitHub pages by the build and test GitHub Action workflow.
To manually deploy the site to GitHub Pages, you would need write access to the gh-pages branch. The deployment itself can be done by running:
statocles -l deploy