Skip to content

PullRequests

Jump to bottom Edit New page
Ryan Jarvis edited this page Feb 2, 2018 · 8 revisions

Do you want to do a pull request?

First things first: THANK YOU!. ESPurna started as a personal project and it will be great if it becomes a community project. There are so many things that can be improved, added and fixed (yeah, a lot a small bugs and not so small bugs there, I'm sure). And sometimes I just don't have the time to work on it as much as I'd like to.

Second. Let's try to keep it homogeneous and readable. I have my coding style. It's mostly standard but sometimes it can be opinionated. It you are willing to do a pull request, there are a few things I would ask you first:

Pull request

  • Do the pull request against the dev branch
  • Only touch relevant files (beware if your editor has auto-formatting feature enabled)
  • If you are adding a new functionality (new hardware, new library support) not related to an existing component move it to it's own modules (.ino file)
  • Make sure you check Coding Style

And thank you again!

Support

If you're looking for support:

  • Issues: this is the most dynamic channel at the moment, you might find an answer to your question by searching open or closed issues.
  • Wiki pages: might not be as up-to-date as we all would like (hey, you can also contribute in the documentation!).
  • Gitter channel: you have better chances to get fast answers from project contributors or other ESPurna users. (also available with any Matrix client!)
  • Issue a question: as a last resort, you can open new question issue on GitHub. Just remember: the more info you provide the more chances you'll have to get an accurate answer.

Home
Change log

Getting started

Supported hardware and options

Configuration

Integrations

Network

Developers

More around ESPurna

Clone this wiki locally