Contribute to Practicalli work¶
Practicalli Kanban board - GitHub Project
All content and interaction with any persons or systems must be done so with respect and within the Practicalli Code of Conduct.
All ideas and content submitted becomes copyright of Practicalli and published under the 
Creative Commons Attribution ShareAlike 4.0 International license.
Attribution will be detailed via GitHub contributors, pull request and issue history.
Reach out to the Practicalli Team before creating a pull request
Raise an issue, start a GitHub discussion or post a message on the #practicalli channel of Clojurians Slack community to avoid disappointment.
Content Tools¶
Practicalli books and websites are written in Python flavor markdown.
Zensical Static site generator generates the published website via a GitHub CI workflow](https://practical.li/engineering-playbook/tools-services/continuous-integration/github/workflow/practicalli/#zensical-static-site-generator).
Zensical can run a local 'reloading' server to support content development, using the make docs target from the Makefile.
The README.md of each project contains install instructions for a local Zensical server.
Issue and ideas¶
Each website has a link to its GitHub repository in the footer of each page.
Use the Practicalli Kanban board to create an issue on any of the Practicalli GitHub repositories.
Pull request¶
All commits must be cryptographically signed
All commits contributed to Practicalli must be signed via a legitimate SSH or GPG key to avoid the risk of commit spoofing.
Configure commit signing with SSH key - Practicalli Engineering
All pull requests must include an entry in CHANGELOG.md or will not be merged. A changelog entry allows the community to follow the changes.
Several GitHub CI workflows run against a PR, checking the format of the content and ensure a changelog entry has been provided.
Please keep pull requests small and focused so they are quick to review and accept. Ideally PR's should be for a specific page or at most a section.
Typographic errors unlikely to be merged
This type of issue indicates a rushed section that requires a rewrite, rather than simply fix a few words. Practicalli books were started over a decade and older content my need a significant rewrite.
Gratitude¶
A huge thank you to all the communities and colleagues that have supported the work published by Practicalli.
The Clojure community has been highly supportive, especially people who joined in with the London Clojurins community, ClojureBridgeLondon, Clojurians Slack community, Clojurians Zulip community.
I am humbled by those who have sponsored the Practicalli websites and videos, providing financial and motivational support.
Special thanks to Bruce Durling for getting me into Cloure in the first place.
Many thanks to the organisers and members of the London Java Community for their support as I started my developer advocacy journey.
