thor/reveal-hugo
1
0
Fork 0
mirror of https://github.com/Threnklyn/reveal-hugo.git synced 2026-05-18 21:03:29 +02:00
Code Issues Packages Projects Releases Wiki Activity

Create CONTRIBUTING.md

Browse Source
This commit is contained in:
Josh Dzielak
2019-02-06 14:17:49 +01:00
committed by GitHub
parent da0a9ce1b5
commit e057d1b958
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+9
View File
@@ -0,0 +1,9 @@
# Contributing to reveal-hugo
Contributions of all shapes and sizes are welcoming, including code, documentation, and examples. If you've built something with reveal-hugo, feel free to add it to the README.
GitHub issues and PRs are the preferred way to receive contributions. Please name your branch something recognizeable.
Before opening a PR, make sure that the reveal-hugo exampleSite builds. The demo presentations in exampleSite use nearly all of the available reveal-hugo functionality, so they're a good indicator of something that might have been broken. Still, there are no fully automated tests, so please make sure to manually test areas that could be impacted by your change.
If you need help contributing, don't hesitate to open an issue and ask. This is a welcoming and beginner-friendly project!