forked from OpenZWave/open-zwave
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add .github files and exclude them from the DistFiles
- Loading branch information
Showing
4 changed files
with
65 additions
and
4 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,35 @@ | ||
Contributing to OpenZWave | ||
========================= | ||
|
||
Thanks for considering to contribute to the OpenZWave Development! | ||
Here are a few tips to help you get started: | ||
|
||
### Contributing New Devices to OZW | ||
Please consult https://github.com/OpenZWave/open-zwave/wiki/Adding-Devices | ||
for the steps and instructions on how to add new devices to OZW | ||
|
||
### Fixing Bugs | ||
Please base your bug fixes against the master branch. The master branch is | ||
considered the stable and is used for our releases. | ||
|
||
Please also use a descriptive commit message | ||
|
||
### Contributing new Features | ||
Our advise before starting work on new features for OZW, is that you discuss | ||
your ideas on the mailing list. This helps ensure that your enhancements | ||
will fits in with our direction for OZW, as well as meets a few requirements | ||
around our API and designs of the library interface. | ||
|
||
All changes should be based against the dev branch, unless advised by a | ||
Maintainer to use a different branch. | ||
|
||
For new command classes, we generally want to evaluate how to expose the new | ||
functionality to applications via ValueID's properly as we do not want to | ||
alter this portion of the API in the future as new revisions of | ||
CommandClasses are released by Sigma. This often requires some in depth | ||
discussions. | ||
|
||
For new platform support, please use the platform abstraction where | ||
possible. try to avoid as much as possible #ifdef statements in the main | ||
code base. | ||
|
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,9 @@ | ||
### Issue Guidelines | ||
|
||
Before opening a new issue, please review the following: | ||
* The Github Issues is for OZW Bugs only. Please do not use this for general questions or howto type conversations. If you have a question, please post to our mailing list at https://groups.google.com/forum/#!forum/openzwave | ||
* Please use the search feature to see if your issues have been raised or addressed first. | ||
* Try the OpenZWave Log Analyzer at http://www.openzwave.com/log-analyzer if you are experiencing problems with a device on your network. | ||
* Often we will require Log Files to help diagnose the issue. Please stop any application you are using, remove zwcfg_*.xml/ozwcache_*.xml files, and restart your application. After experiencing your issue, stop your application and attach the OZW_Log.txt file to this issue (please do not filter the log file, we often need the full log file to diagnose issues) | ||
* If you want to add a new device to the OZW Database, please consult https://github.com/OpenZWave/open-zwave/wiki/Adding-Devices | ||
|
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
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