Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 1.62 KB

CONTRIBUTING.md

File metadata and controls

37 lines (24 loc) · 1.62 KB

Contributing

I like pull requests from everyone. By participating in this project, you agree to follow the code of conduct below

Fork the development branch, then clone the repo

Make your modification,

  • If you want to add a new gateway, name it ZgatewayXXX, XXX replaced by your gateway communication type, can be more than three letters
  • If you want to add a new sensor, name it ZsensorYYY, YYY replaced by your sensor type, can be more than three letters
  • If you want to add a new actuator, name it ZactuatorZZZ, ZZZ replaced by your actuator type, can be more than three letters

Review your code, compile it for Arduino Uno and ESP8266

Test it localy on your hardware config

If you modify User_config.h during your developments you need to report your modifications into Test_config.h https://github.com/1technophile/OpenMQTTGateway/blob/master/tests/Test_config.h Indeed during the continuous integration process User_config.h is replaced by Test_config.h. Test_config.h as much more gateway/sensors enabled for the test than the default User_config.h

Emit a pull request

Verify the travis CI compilation results

Request for review

I may suggest some changes or improvements or alternatives.

Some things that will increase the chance that your pull request is accepted: