Skip to content

Commit

Permalink
Update license details an support materials.
Browse files Browse the repository at this point in the history
  • Loading branch information
schmidtw committed Nov 4, 2017
1 parent 61ee6ac commit a461a7d
Show file tree
Hide file tree
Showing 35 changed files with 558 additions and 37 deletions.
Binary file removed CLA.pdf
Binary file not shown.
34 changes: 30 additions & 4 deletions CONTRIBUTING.md
@@ -1,5 +1,31 @@
If you would like to contribute code to this project you can do so
through GitHub by forking the repository and sending a pull request.
Contribution Guidelines
=======================

Before Comcast accepts your code into the project you must sign the
Comcast Contributor License Agreement ('CLA.pdf').
We love to see contributions to the project and have tried to make it easy to do so. If you would like to contribute code to this project you can do so through GitHub by forking the repository and sending a pull request.

Before Comcast merges your code into the project you must sign the [Comcast Contributor License Agreement (CLA)](https://gist.github.com/ComcastOSS/a7b8933dd8e368535378cda25c92d19a).

If you haven't previously signed a Comcast CLA, you'll automatically be asked to when you open a pull request. Alternatively, we can e-mail you a PDF that you can sign and scan back to us. Please send us an e-mail or create a new GitHub issue to request a PDF version of the CLA.

For more details about contributing to GitHub projects see
http://gun.io/blog/how-to-github-fork-branch-and-pull-request/

Documentation
-------------

If you contribute anything that changes the behavior of the
application, document it in the [README](https://github.com/Comcast/parodus/blob/master/README.md) or [wiki](https://github.com/Comcast/parodus/wiki)! This includes new features, additional variants of behavior and breaking changes.

Testing
-------

Tests are written using golang's standard testing tools, and are run prior to the PR being accepted.

Pull Requests
-------------

* should be narrowly focused with no more than 3 or 4 logical commits
* when possible, address no more than one issue
* should be reviewable in the GitHub code review tool
* should be linked to any issues it relates to (i.e. issue number after (#) in commit messages or pull request message)
* should conform to idiomatic golang code formatting
16 changes: 16 additions & 0 deletions NOTICE
@@ -0,0 +1,16 @@
parodus
Copyright 2017 Comcast Cable Communications Management, LLC

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

This product includes software developed at Comcast (http://www.comcast.com/).
17 changes: 16 additions & 1 deletion src/ParodusInternal.c
@@ -1,9 +1,24 @@
/**
* Copyright 2015 Comcast Cable Communications Management, LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
/**
* @file ParodusInternal.c
*
* @description This file is used to manage internal functions of parodus
*
* Copyright (c) 2015 Comcast
*/

#include "ParodusInternal.h"
Expand Down
17 changes: 16 additions & 1 deletion src/ParodusInternal.h
@@ -1,9 +1,24 @@
/**
* Copyright 2015 Comcast Cable Communications Management, LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
/**
* @file ParodusInternal.h
*
* @description This file is used to manage internal functions of parodus
*
* Copyright (c) 2015 Comcast
*/
#ifndef _PARODUSINTERNAL_H_
#define _PARODUSINTERNAL_H_
Expand Down
17 changes: 16 additions & 1 deletion src/client_list.c
@@ -1,9 +1,24 @@
/**
* Copyright 2015 Comcast Cable Communications Management, LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
/**
* @file client_list.h
*
* @description This file is used to manage registered clients
*
* Copyright (c) 2015 Comcast
*/

#include "ParodusInternal.h"
Expand Down
17 changes: 16 additions & 1 deletion src/client_list.h
@@ -1,9 +1,24 @@
/**
* Copyright 2015 Comcast Cable Communications Management, LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
/**
* @file client_list.h
*
* @description This file is used to manage registered clients
*
* Copyright (c) 2015 Comcast
*/
#ifndef _CLIENTLIST_H_
#define _CLIENTLIST_H_
Expand Down
17 changes: 16 additions & 1 deletion src/config.c
@@ -1,9 +1,24 @@
/**
* Copyright 2015 Comcast Cable Communications Management, LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
/**
* @file config.h
*
* @description This file contains configuration details of parodus
*
* Copyright (c) 2015 Comcast
*/

#include <stdio.h>
Expand Down
17 changes: 16 additions & 1 deletion src/config.h
@@ -1,9 +1,24 @@
/**
* Copyright 2015 Comcast Cable Communications Management, LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
/**
* @file config.h
*
* @description This file contains configuration details of parodus
*
* Copyright (c) 2015 Comcast
*/

#ifndef _CONFIG_H_
Expand Down
17 changes: 16 additions & 1 deletion src/conn_interface.c
@@ -1,9 +1,24 @@
/**
* Copyright 2015 Comcast Cable Communications Management, LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
/**
* @file conn_interface.c
*
* @description This decribes interface to create WebSocket client connections.
*
* Copyright (c) 2015 Comcast
*/

#include "connection.h"
Expand Down
18 changes: 16 additions & 2 deletions src/conn_interface.h
@@ -1,11 +1,25 @@
/**
* Copyright 2015 Comcast Cable Communications Management, LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
/**
* @file conn_interface.h
*
* @description This header defines interface to create WebSocket client connections.
*
* Copyright (c) 2015 Comcast
*/

#ifndef _CONN_INTERFACE_H_
#define _CONN_INTERFACE_H_

Expand Down
17 changes: 16 additions & 1 deletion src/connection.c
@@ -1,9 +1,24 @@
/**
* Copyright 2015 Comcast Cable Communications Management, LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
/**
* @file connection.c
*
* @description This decribes functions required to manage WebSocket client connections.
*
* Copyright (c) 2015 Comcast
*/

#include "connection.h"
Expand Down
17 changes: 16 additions & 1 deletion src/connection.h
@@ -1,9 +1,24 @@
/**
* Copyright 2015 Comcast Cable Communications Management, LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
/**
* @file connection.h
*
* @description This header defines functions required to manage WebSocket client connections.
*
* Copyright (c) 2015 Comcast
*/

#ifndef _CONNECTION_H_
Expand Down
17 changes: 16 additions & 1 deletion src/downstream.c
@@ -1,9 +1,24 @@
/**
* Copyright 2015 Comcast Cable Communications Management, LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
/**
* @file downstream.c
*
* @description This describes functions required to manage downstream messages.
*
* Copyright (c) 2015 Comcast
*/

#include "downstream.h"
Expand Down
17 changes: 16 additions & 1 deletion src/downstream.h
@@ -1,9 +1,24 @@
/**
* Copyright 2015 Comcast Cable Communications Management, LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
/**
* @file downstream.h
*
* @description This header defines functions required to manage downstream messages.
*
* Copyright (c) 2015 Comcast
*/

#ifndef _DOWNSTREAM_H_
Expand Down
17 changes: 16 additions & 1 deletion src/nopoll_handlers.c
@@ -1,9 +1,24 @@
/**
* Copyright 2015 Comcast Cable Communications Management, LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
/**
* @file nopoll_handlers.c
*
* @description This describes nopoll handler functions.
*
* Copyright (c) 2015 Comcast
*/

#include "ParodusInternal.h"
Expand Down

0 comments on commit a461a7d

Please sign in to comment.