Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
20 lines (20 loc) · 1.03 KB

CONTRIBUTING.md

File metadata and controls

20 lines (20 loc) · 1.03 KB

Contributing

If you're reading this, thanks for taking the time to contribute to Puddle! Here are some guidelines for contributing.

Structure

File structure

Puddle uses Electron, HTML, CSS, and JavaScript. The base app can be found in the src folder, and build configuration is located in package.json. Puddle uses electron-builder for builds, and update-electron-app for auto-updating.

Apps and bots

Puddle uses depfu and imgbot.

How to contribute

Report bugs

Before you report a bug on Puddle, make sure that it isn't based on the version of Puddle you have. Once you're sure, you can create an Issue with your bug report in it.

Request features

We love new ideas! Just add yours to Issues, and we'll take a look.

Contributing code

Code contributions are absolutely welcome too! Just follow our styleguide and create a pull request.

Styleguides

Styleguide for JavaScript

Here's our short and simple style guide:

  • Use 2 spaces for indentation
  • Use semicolons
  • Use spaces (see current code for details)