michaelh/hugo-academic-mirror
1
0
Fork 0
mirror of https://github.com/gcushen/hugo-academic.git synced 2025-07-26 19:15:16 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs: make CONTRIBUTING.md easier to find

Browse source
This commit is contained in:
George Cushen 2022-09-02 20:18:39 +01:00
commit 8aebca9c53
3 changed files with 20 additions and 40 deletions
Download patch file Download diff file Expand all files Collapse all files

19
.github/support.md vendored
View file

@ -1,19 +0,0 @@
# How to get support for Wowchemy 👨‍💬👩‍💬
🚑 For **help** and **questions**, solve common issues with the [**Troubleshooting Guide**](https://wowchemy.com/docs/guide/troubleshooting/).
For other issues, search if your question has already been asked on the community **[chat](https://discord.gg/z8wNYzb)** and **[forum](https://github.com/wowchemy/wowchemy-hugo-themes/discussions)**, and if not, consider posting a new thread there.
Please **_do not_** raise an issue on GitHub.
Also, you can search and browse the extensive [Wowchemy](https://wowchemy.com/docs/) and [Hugo](https://gohugo.io/documentation/) **documentation**.
For questions on _Blogdown_, please reach out to the [Blogdown community](https://github.com/rstudio/blogdown).
Issues which are not bug reports or feature requests will be closed.
## Why not GitHub?
GitHub is our project management tool, it's the place where our volunteers contribute. We use the issue list to keep track of bugs and new features that we are working on. We do this openly for transparency.
With the chat and forum, you can leverage the knowledge of our wider community to get help with any problems you are having with Wowchemy. Please keep in mind that Wowchemy is Free Open Source Software (FOSS), and free support is provided by the goodwill of our wonderful community members.

39
.github/contributing.md → CONTRIBUTING.md
View file

@ -8,25 +8,37 @@ We want contributing to Wowchemy to be fun, enjoyable, and educational for anyon
Join the **Contributing** channel on the **[community Discord](https://discord.gg/z8wNYzb)**.
## General ways to help
Whether or not you're a developer, there are plenty of non-technical ways that you can help. We always need help with:
- Helping the Wowchemy community via the live [chat](https://discord.gg/z8wNYzb) and [forum](https://github.com/wowchemy/wowchemy-hugo-themes/discussions)
- Investigating and reviewing open [Issues](https://github.com/wowchemy/wowchemy-hugo-themes/issues) and [Pull Requests](https://github.com/wowchemy/wowchemy-hugo-themes/pulls)
- Influence the roadmap! Give a thumbs up 👍 to upvote a feature request you would like to use
- 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, such as checking the latest version of the templates work as you expect and fixing any dead-links etc.
- Translating the Wowchemy templates or the Wowchemy documentation
- Hosting local Wowchemy themed events or meetups
- Promoting Wowchemy to others by blogging, vlogging, code streaming, talking etc.
### For technical contributions
Repository structure:
- modules
- The components and layouts which form the Wowchemy page building framework that the templates depend on
- scripts
- A collection of scripts for helping maintain the repository
- starters
- The collection of starter templates (aka Hugo themes)
- To contribute an improvement to a starter template, make your changes to the relevant template within this folder. **Do not submit PRs to the dedicated template repositories as they are read-only.**
- wowchemy
- The components and layouts which form the Wowchemy page building framework that the templates depend on
- wowchemy-cms
- The admin panel that enables users to edit their content on the go
- test
- a minimal site that is built by the CI on every commit to help test PRs
#### What are some good issues to contribute to?
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-themes/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-themes/labels/help%20wanted) label encompassing issues which need some love.
If you're a developer looking to contribute, but you're not sure where to begin, check out the [help wanted](https://github.com/wowchemy/wowchemy-hugo-themes/labels/help%20wanted) label on Github, which contains issues which need some love.
#### How can I propose an improvement?
@ -115,19 +127,6 @@ To help us develop this free software sustainably under the open source license,
- ☕️ [**Donate a coffee**](https://github.com/sponsors/gcushen?frequency=one-time)
- ❤️ [**Become a sponsor and unlock awesome rewards**](https://wowchemy.com/sponsor/)
## 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](https://discord.gg/z8wNYzb) and [forum](https://github.com/wowchemy/wowchemy-hugo-themes/discussions)
- Investigating and reviewing open [Issues](https://github.com/wowchemy/wowchemy-hugo-themes/issues) and [Pull Requests](https://github.com/wowchemy/wowchemy-hugo-themes/pulls)
- Give a thumbs up 👍 to upvote a feature request you would like to use
- 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 Wowchemy themed events or meetups
- Promoting Wowchemy to others by blogging, vlogging, code streaming, talking etc.
## Best practices
To create a consistent experience for all contributors and help prevent bugs, we have some best practices.

2
README.md
View file

@ -28,7 +28,7 @@
- 🐦 Share your Wowchemy site with the community on Twitter: [@wowchemy](https://twitter.com/wowchemy) [@GeorgeCushen](https://twitter.com/GeorgeCushen) [#MadeWithWowchemy](https://twitter.com/search?q=%23MadeWithWowchemy&src=typed_query)
- 🗳 [Take the survey and help us improve #OpenSource](https://forms.gle/NioD9VhUg7PNmdCAA)
- ⬆️ **Updating?** View the [Update Guide](https://wowchemy.com/docs/hugo-tutorials/update/) and [Release Notes](https://github.com/wowchemy/wowchemy-hugo-themes/releases)
- 🚀 [Contribute improvements](./.github/contributing.md) or [suggest improvements](https://github.com/wowchemy/wowchemy-hugo-themes/issues)
- 🚀 [Contribute improvements](CONTRIBUTING.md) or [suggest improvements](https://github.com/wowchemy/wowchemy-hugo-themes/issues)
<p align="center"><a href="https://wowchemy.com/docs/getting-started/hugo-cms/" target="_blank" rel="noopener"><img src="./.github/media/write-from-phone.gif" alt="Wowchemy CMS"></a></p>