|
@@ -1,43 +1,53 @@
|
|
|
# Contributing to Wowchemy
|
|
|
|
|
|
-For **help**, **support**, and **questions** please use our **[community chat](https://discord.gg/z8wNYzb)** 🚑.
|
|
|
+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](https://discord.gg/z8wNYzb)**.
|
|
|
+
|
|
|
Learn [how to contribute code on Github](https://codeburst.io/a-step-by-step-guide-to-making-your-first-github-contribution-5302260a2940).
|
|
|
|
|
|
-If you're a developer looking to contribute, but you're not sure where to begin, check out the [good first issue](https://github.com/gcushen/hugo-academic/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) label on Github, which contains small tasks that have been specifically flagged as being friendly to new contributors.
|
|
|
+If you're a developer looking to contribute, but you're not sure where to begin, check out the [good first issue](https://github.com/wowchemy/wowchemy-hugo-modules/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) 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](https://github.com/wowchemy/wowchemy-hugo-modules/labels/help%20wanted) 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](https://github.com/wowchemy/wowchemy-hugo-modules/pulls).
|
|
|
+
|
|
|
+If you have an idea for a new feature, please start by [searching the issues](https://github.com/wowchemy/wowchemy-hugo-modules/issues) to check that the feature has not already been suggested and then suggest it by [opening a new issue](https://github.com/wowchemy/wowchemy-hugo-modules/issues/new/choose), as adding new features to Wowchemy first requires some analysis around the design and spec.
|
|
|
+
|
|
|
+### Contribute a language pack
|
|
|
|
|
|
-After that, if you're looking for something a little more challenging to sink your teeth into, there's a broader [help wanted](https://github.com/gcushen/hugo-academic/labels/help%20wanted) label encompassing issues which need some love.
|
|
|
+To contribute a **new language pack** or an improvement to a language pack, refer to the [language pack guide](https://wowchemy.com/docs/language/#create-or-modify-a-language-pack). Once created, [fork Wowchemy Hugo Modules](https://github.com/wowchemy/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.
|
|
|
|
|
|
-If you have a straightforward bug fix or improvement, feel free to contribute it in a [Pull Request](https://github.com/gcushen/hugo-academic/pulls).
|
|
|
+### Contribute a theme pack
|
|
|
|
|
|
-If you have an idea for a new feature, please start by [searching the issues](https://github.com/gcushen/hugo-academic/issues) to check that the feature has not already been suggested and then suggest it by [opening a new issue](https://github.com/gcushen/hugo-academic/issues/new/choose), as adding new features to Academic first requires some analysis around the design and spec.
|
|
|
+[View the guide](https://wowchemy.com/docs/customization/#share-your-theme)
|
|
|
|
|
|
-To contribute a **new language pack**, refer to the [language pack guide](https://sourcethemes.com/academic/docs/language/#create-or-modify-a-language-pack). Once created, place you language pack in `academic/i18n/`, add the name of the language to `academic/data/i18n/language.yaml`, and open a Pull Request on Github with these two files.
|
|
|
+### Contribute a template
|
|
|
|
|
|
-To contribute to **Academic Admin**, the automatic publication importer, refer to [its dedicated Github repository](https://github.com/sourcethemes/academic-admin).
|
|
|
+Consider forking a bare-bones template such as [Hello Starter](https://github.com/wowchemy/starter-hello-world) 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.
|
|
|
|
|
|
-## Stickers
|
|
|
+### Contribute to the Publication importer
|
|
|
|
|
|
-🖼️ [Decorate your laptop or journal with an Academic **sticker**](https://www.redbubble.com/people/neutreno/works/34387919-academic)
|
|
|
+To contribute to **Hugo Academic CLI**, the automatic publication importer, refer to [its dedicated Github repository](https://github.com/wowchemy/hugo-academic-cli) and Issue queue.
|
|
|
|
|
|
-## Donations
|
|
|
+## Become a backer
|
|
|
|
|
|
-As a pure community-driven open source project, we welcome your support:
|
|
|
+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:
|
|
|
|
|
|
- ☕️ [**Donate a coffee**](https://paypal.me/cushen)
|
|
|
- - 💵 [Become a backer on **Patreon**](https://www.patreon.com/cushen)
|
|
|
+ - ❤️ [**Become a sponsor and unlock awesome rewards**](https://wowchemy.com/plans/)
|
|
|
|
|
|
## 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 our Academic community on the [chat](https://spectrum.chat/academic)
|
|
|
-- Improving the [documentation](https://sourcethemes.com/academic/docs/) and writing tutorials
|
|
|
- - Just click the _Edit_ button at the bottom of pages or contribute to the [documentation repository](https://github.com/sourcethemes/academic-www)
|
|
|
+- Helping the Wowchemy community on the [chat](https://discord.gg/z8wNYzb) and [forum](https://github.com/wowchemy/wowchemy-hugo-modules/discussions)
|
|
|
+- Improving the [documentation](https://wowchemy.com/docs/) 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 Academic themed events or meetups
|
|
|
-- Promoting Academic to others by blogging, vlogging, code streaming, talking etc.
|
|
|
+- Hosting local Wowchemy themed events or meetups
|
|
|
+- Promoting Wowchemy to others by blogging, vlogging, code streaming, talking etc.
|