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

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Josh Dzielak
2019-02-06 14:19:45 +01:00
committed by GitHub
parent e057d1b958
commit 2b431e7285
1 changed files with 18 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+18
View File
@@ -2,6 +2,24 @@
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. 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.
To run the example site, clone this repository and run:
```shell
hugo server -s exampleSite
```
or simply...
```shell
npm start
```
You can also build the site without watching it for changes by running:
```shell
npm run build
```
GitHub issues and PRs are the preferred way to receive contributions. Please name your branch something recognizeable. 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. 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.