Skip to content

Commit

Permalink
add .github files and exclude them from the DistFiles
Browse files Browse the repository at this point in the history
  • Loading branch information
Fishwaldo committed Sep 28, 2016
1 parent 1d59209 commit 133006c
Show file tree
Hide file tree
Showing 4 changed files with 65 additions and 4 deletions.
35 changes: 35 additions & 0 deletions .github/CONTRIBUTING.md
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.

9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE.md
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

9 changes: 5 additions & 4 deletions distfiles.mk
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ DISTFILES = .gitignore \
config/aeotec/zw120.xml \
config/aeotec/zw121.xml \
config/aeotec/zw130.xml \
config/assa_abloy/KeyfreeConnected.xml \
config/assa_abloy/RealLivingCapTouch.xml \
config/cooper/RF9505-T.xml \
config/cooper/RF9540-N.xml \
Expand Down Expand Up @@ -158,8 +159,8 @@ DISTFILES = .gitignore \
config/ge/12724-dimmer.xml \
config/ge/dimmer.xml \
config/ge/dimmer_module.xml \
config/ge/relay.xml \
config/ge/receptacle.xml \
config/ge/relay.xml \
config/gr/gr105.xml \
config/gr/gr105n.xml \
config/greenwave/powernode1.xml \
Expand Down Expand Up @@ -264,13 +265,13 @@ DISTFILES = .gitignore \
config/remotec/zts-110.xml \
config/remotec/zurc.xml \
config/remotec/zxt-120.xml \
config/shenzen_neo/nas-ds01z.xml \
config/shenzen_neo/nas-pd01z.xml \
config/shenzen_neo/nas-wr01z.xml \
config/schlage/BE469NXCEN.xml \
config/schlagelink/itemp.xml \
config/schlagelink/minikeypad.xml \
config/sensative/strips.xml \
config/shenzen_neo/nas-ds01z.xml \
config/shenzen_neo/nas-pd01z.xml \
config/shenzen_neo/nas-wr01z.xml \
config/stelpro/stzw402.xml \
config/swiid/swiidinter.xml \
config/swiid/swiidplug.xml \
Expand Down
16 changes: 16 additions & 0 deletions makedist
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,15 @@
use strict;
use XML::Simple;
use Data::Dumper;
use File::Basename;
use List::Util 1.33 'any';

my $input = ".distfiles";
my $output = "distfiles.mk";

my @excludedir = (".github");
my @excludefile = ();

open( my $fh => $input) || die "Cannot open $input: $!";
open( my $oh, ">", $output) || die "Cannot open $output: $!";

Expand All @@ -17,6 +22,17 @@ print $oh "DISTFILES =\t";

while(my $line = <$fh>) {
chomp($line);
my $dir = dirname($line);
if (any {/^$dir$/} @excludedir)
{
print "Excluded File $line - (Directory Excluded)\n";
next;
}
if (any {/^$line$/} @excludefile)
{
print "Excluded File $line - (File Excluded)\n";
next;
}
print $oh $line." \\\n\t";
}
print $oh "cpp/src/vers.cpp\n";
Expand Down

0 comments on commit 133006c

Please sign in to comment.