contributing.md 3.8 KB
Contributing to Wowchemy
Thanks for being interested in contributing! We’re so glad you want to help!
We want contributing to Wowchemy to be fun, enjoyable, and educational for anyone and everyone. All contributions are welcome, including issues, new docs as well as updates and tweaks, blog posts, workshops, and more.
Where to Start
Join the Contributing channel on the community Discord.
Learn how to contribute code on Github.
If you're a developer looking to contribute, but you're not sure where to begin, check out the good first issue label on Github, which contains small tasks that have been specifically flagged as being friendly to new contributors.
After that, if you're looking for something a little more challenging to sink your teeth into, there's a broader help wanted label encompassing issues which need some love.
If you have a straightforward bug fix or improvement, feel free to contribute it in a Pull Request.
If you have an idea for a new feature, please start by searching the issues to check that the feature has not already been suggested and then suggest it by opening a new issue, as adding new features to Wowchemy first requires some analysis around the design and spec.
Contribute a language pack
To contribute a new language pack or an improvement to a language pack, refer to the language pack guide. Once created, fork Wowchemy Hugo Modules, place your language pack in wowchemy/i18n/, add the name of the language to wowchemy/data/i18n/language.yaml, and open a Pull Request on Github with these two files.
Contribute a theme pack
Contribute a template
Consider forking a bare-bones template such as Hello Starter on GitHub and building up your own template using the Wowchemy Hugo Module. Reach out on the Contributing channel in Discord to submit your template.
Contribute to the Publication importer
To contribute to Hugo Academic CLI, the automatic publication importer, refer to its dedicated Github repository and Issue queue.
Become a backer
To help us develop this free software sustainably under the open source license, we ask all individuals and businesses that use it to help support its ongoing maintenance and development via sponsorship:
Other ways to help
If you're not a developer there are still plenty of ways that you can help. We always need help with:
- Helping the Wowchemy community on the chat and forum
- Improving the documentation and writing tutorials
- Just click the Edit button at the bottom of pages or open an issue with your proposed improvement
- Testing and quality assurance
- Hosting local Wowchemy themed events or meetups
- Promoting Wowchemy to others by blogging, vlogging, code streaming, talking etc.