Contributing to this guide and to Spacemacs
practicalli/spacemacs-content contains the markdown content used to generate the book. Please raise all issues and pull requests on this website.
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, it will be reviewed and changes merged eventually.
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 in the contributors section of this workshop.
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:
- Fork the Spacemacs project on GitHub and clone your fork
- Create a new branch from the
SPC g sfor magit status,
b cto create a new branch)
- Make changes and update relevant README files and the CHANGELOG.develop file
- Commit changes to the new branch and push to your fork.
- 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