Tutorial Contributing Back To ESPEasy

From Let's Control It
Revision as of 00:07, 3 March 2017 by Psy0rz (talk | contribs)
Jump to navigation Jump to search

If you followed Tutorial_preparing_to_work_with_github and you've made some changes, they you're ready to contribute them back to us.

This will make sure your changes will be in the next release so you dont have to make the same changes again.

Also it makes ESPEasy better for everyone.

Before you continue, make sure that your changes follow to our guidelines: ESPEasyDevelopmentGuidelines


Committing changes

When you commit a change, you add it to the git-history. Its best to make a commit for every logical thing you've did.

So if you are going to fix 2 different bugs, make a separate commit for each one.

If you're working on a new plugin, its ok to do several commits during the development process. This might keep things more clear for yourself, and also allows you to undo mistakes by rolling them back.

If you really want to learn how to work with Git, we can recommend the free Pro Git book: https://git-scm.com/book/en/v2

Commiting with Github desktop

  • Open Git Desktop to view your changes:

Git changes.png

  • Review the changes to make sure there are no unexpected changes or mistakes left.
  • Add a commit message describing what you fixed or added:

Git commit message.png

  • Press Commit to commit the changes.

Now you can go on and make more changes.

Press the Sync button to public your changes to github, that way you also have a backup.

When you've something you want to contribute with us go to the next step.

Retrieved from "http://www.letscontrolit.com/wiki/index.php?title=Tutorial_Contributing_Back_To_ESPEasy&oldid=1564"