Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
16 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
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) | ||
* If you are adding new library, include it in one of the **sample travis profiles**, so our integrated CI will try to compile it. | ||
* Make sure you check [Coding Style](CodingStyle) | ||
* PRs that don't compile (break Travis) or cause more coding errors (as reported by Codacy) will not be merged. Please fix the issue. Same goes for PRs that are raised against older commit in dev - you might need to rebase and resolve conflicts. | ||
|
||
|
||
And thank you again! |
eb249dd
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Coding Style Link is Broken