Contributing to Practicalliλ︎
Practicalli books are written in markdown and use MkDocs to generate the published website via a GitHub workflow. MkDocs can also run a local server using the
make docs target from the
Issues Pull requests practicalli/spacemacs.d
practicalli/spacemacs is written in markdown and uses MkDocs to generate the website via a GitHub action.
practicalli/spacemacs.d contains the complete Spacemacs configuration used in this guide written in Emacs Lisp, with its own Issues and pull requests
By submitting content ideas and corrections you are agreeing they can be used in this workshop under the Creative Commons Attribution ShareAlike 4.0 International license. Attribution will be detailed via GitHub contributors.
All content and interaction with any persons or systems must be done so with respect and within the Practicalli Code of Conduct.
Submit and issue or ideaλ︎
Raise an issue via the GitHub repository when
- a page contains examples or explaintions that are not clear, suggesting an alternative where relevant.
- a topic is not covered or further examples are required
For small issues or if a discussion is required, post a message on #practicalli channel of the Clojurians Slack community.
Considering a Pull request?λ︎
Before investing any time in a pull request, please raise a new issue explaining the situation. This can save you and the maintainer time and avoid rejected pull requests.
Please keep pull requests small and focused, as they are much quicker to review and easier to accept. Ideally PR's should be for a specific page or at most a section.
A PR with a list of changes across different sections will not be merged, although it may be reviewed at some point with changes cherry picked.
Issues such as grammar improvements are typically a sign of a rushed section that requires a rewrite, so a pull request to fix a typeographic error will probably not be merged. Raise an issue, or post a thread in the Clojurians Slack #practicall channel
Contributing to Spacemacsλ︎
The Spacemacs contribution guidelines details how to get help, report issues and contribute to the project.
SPC h I to raise an issue on the Spacemacs GitHub issue tracker, automatically including your Spacemacs and Operating system details.
Please review issues and leave feedback, especially confirming issues are reproducible on your Spacemacs configuration.
SPC h d s to include your system configuration.
Contribute changes via pull requests:
1. Fork the Spacemacs project on GitHub and clone your fork
2. Create a new branch from the
develop branch (
SPC g s for magit status,
b c to create a new branch)
3. Make changes and update relevant README files and the CHANGELOG.develop file
4. Commit changes to the new branch and push to your fork.
5. Visit your fork on GitHub and create a pull request (or setup forge and create PR from Magit)
Making a change to a pull request you have created is also easy to do
Thank you to all contributorsλ︎
A huge thank you to Rich Hickey and the team at Cognitect for creating and continually guiding the Clojure language. Special thank you to Alex Miller who has provided excellent advice on working with Clojure and the CLI tooling.
I would also like to thank everyone that has joined in with the London Clojurins community, ClojureBridgeLondon, Clojurians Slack community, Clojurians Zulip community and Clojureverse community.
Thank you to everyone who sponsors the Practicalli websites and videos and for the recent Clojurists Together sponsorship, it helps me continue the work at a much faster pace.
Special thanks to Bruce Durling for getting me into Cloure in the first place.
duianto for discussions and accepting my pull requests to Spacemacs
In no specific order, the following people have provided valuable input to this work
- Chris Howe-Jones - @agile-geek
- Colin Yates - @yatesco
- Jun Tian
- Stefan Pfeiffer