Skip to content

Commit

Permalink
Update the readme and contributing docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
schmidtw committed Sep 27, 2017
1 parent c229cbd commit 413680a
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 7 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/talaria/blob/master/README.md) or [wiki](https://github.com/Comcast/talaria/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
6 changes: 3 additions & 3 deletions README.md
Expand Up @@ -13,15 +13,15 @@ The Xmidt routing agent.

## Centos 6

1. Import the public GPG key (replace `v0.0.1-65alpha` with the release you want)
1. Import the public GPG key (replace `0.0.1-65` with the release you want)

```
rpm --import https://github.com/Comcast/talaria/releases/download/v0.0.1-65alpha/RPM-GPG-KEY-comcast-xmidt
rpm --import https://github.com/Comcast/talaria/releases/download/0.0.1-65/RPM-GPG-KEY-comcast-xmidt
```

2. Install the rpm with yum (so it installs any/all dependencies for you)

```
yum install https://github.com/Comcast/talaria/releases/download/v0.0.1-65alpha/talaria-0.0.1-65.el6.x86_64.rpm
yum install https://github.com/Comcast/talaria/releases/download/0.0.1-65/talaria-0.0.1-65.el6.x86_64.rpm
```

0 comments on commit 413680a

Please sign in to comment.