Skip to content

Latest commit

 

History

History
65 lines (42 loc) · 1.92 KB

CONTRIBUTING.md

File metadata and controls

65 lines (42 loc) · 1.92 KB

Contributing

Thanks for thinking about making reveal-ck better!!

Anyone can help-- regardless of whether you're a developer or not.

Please read through the following and let me know if you have any questions!

😄

Ways to Help

Please start by understanding the overall goal of reveal-ck:

reveal-ck exists to make it easy for anyone to create a reasonably pretty presentation with a minimal amount of work.

And further, it has several other design ideas:

reveal-ck aims to reduce a presentation into a single file.

And also,

If you need more than one file to describe your presentation (say, you've got images) then those extra files should be stored in a reasonable place.

This means things like images should live in a directory named images/ and CSS should live in a directory named css/, and more generally, there shouldn't be any surprises as you flesh out your presentation.

And:

The modern day web browser is powerful enough to be your presentation run time.

Use fonts, regular images, animation gifs, and colors, and do it without any extra software on your phone, tablet, or computer. If it's a modern browser than it should just work.

With that said..

If you'd like to help out, you could:

Log a Bug

If you see a problem with reveal-ck, please log an issue and let us know what's up. You can do this by visiting the Github issues page: https://github.com/jedcn/reveal-ck/issues/.

Propose a Feature

Several advances in reveal-ck have come because people created an issue that described a feature they wished it had. If you're thinking that you want reveal-ck to work in a new way, please write it up submit an issue. Whether we implement it or you implement it-- this is a great way to start off.

Get Involved with Development

If you'd like to track something down yourself, you can find instructions for getting started with local development in docs/DEVELOPMENT.md.