Permalink
Browse files

Update README, CODE_OF_CONDUCT, and CONTRIBUTING docs. Release prep.

  • Loading branch information...
imbriaco committed Feb 20, 2016
1 parent b713df0 commit 550007b656bbc1f4dc9d07572bb418573a668548
Showing with 62 additions and 12 deletions.
  1. +6 −6 CODE_OF_CONDUCT.md
  2. +27 −1 CONTRIBUTING.md
  3. +29 −5 README.md
View
@@ -55,12 +55,12 @@ further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting [Mark Imbriaco](mailto:mark@operable.io) or [Kevin
Smith](mailto:kevin@operable.io). All complaints will be reviewed and investigated
and will result in a response that is deemed necessary and appropriate to the
circumstances. The project team is obligated to maintain confidentiality with
regard to the reporter of an incident. Further details of specific enforcement
policies may be posted separately.
reported by contacting [founders@operable.io](mailto:founders@operable.io).
All complaints will be reviewed and investigated and will result in a response
that is deemed necessary and appropriate to the circumstances. The project team
is obligated to maintain confidentiality with regard to the reporter of an
incident. Further details of specific enforcement policies may be posted
separately.
## Attribution
View
@@ -1 +1,27 @@
This is a placeholder file. Contribution guidelines to be added soon.
# Contributing to Cog
Thank you for your interest in contributing to Cog. We are grateful for contributions of all kinds; reporting issues, updating documentation, fixing bugs, implementing new features, and any other type of contribution is hugely beneficial to Cog and our community. We're excited to see what you come up with!
Before submitting your contribution, please review the following guidelines. These are intended to make the contribution process as simple and predictable as possible for both contributors and project maintainers.
## Code of Conduct
All Operable sponsored projects require contributors to behave in accordance with our [Code of Conduct](https://github.com/operable/cog/blob/master/CODE_OF_CONDUCT.md) which is adapted from the [Contributor Covenant](http://contributor-covenant.org/). Please report any behavior that violates the code of conduct to [founders@operable.io](mailto:founders@operable.io) so that we can investigate and take action as necessary.
## Pull Request Workflow
1. Fork the project repository and create a topic branch in your fork for your work. This fork should almost always be made against the `master` branch of the project you're working on, unless you have previously discussed basing your changes on a different branch with the Operable team.
2. Make your changes, including any necessary tests to cover new features or fixes that you make.
3. Ensure that all tests pass.
4. Submit a Pull Request against the `master` branch of the project you're working on.
5. The project committers review pull requests regularly and will work with contributors to provide feedback and guidance around any changes that are required before the pull request can be accepted.
## Contributor License Agreement (CLA)
All contributions that do not fall within the Trivial Patch Exemption guidelines below require a [Contributor License Agreement](https://github.com/operable/cog/wiki/Contributor-License-Agreement) to be signed in order be considered.
## Trivial Patches
All patches that involve creative work are protectable under a copyright, so we require a CLA to be on file.
If your patch is extremely small (generally fewer than 10 lines) and does not introduce new functionality, it may be accepted without a CLA. In some cases, changes may be deemed Trivial even if they are longer than 10 lines if they are obvious changes such as minor documentation fixes, build script updates, configuration changes, and reordering of existing code. We review all pull requests to determine whether they require a CLA before merging and will let you know if you need to complete one.
View
@@ -1,11 +1,35 @@
# Cog
Cog is an open chatops platform that gives you a secure, collaborative command line right in your chat window.
Cog is an open chatops platform that gives you a secure, collaborative command line right in your chat window. It is designed to be secure, highly available, chat provider agnostic, and to be extensible using your favorite programming language.
## Private Alpha
![cog-demo-20](https://cloud.githubusercontent.com/assets/1198/13233523/00b9f602-d982-11e5-9177-9442e3ff54de.gif)
Thank you for participating in the private alpha test for Cog! Please use [GitHub Issues](https://github.com/operable/cog/issues) to report problems, make feature requests, or to ask questions that don't need an immediate response.
## Status
While Cog is open source, we'd really appreciate it if you didn't share the code until we release it publicly.
Cog is currently in public alpha and is not currently recommended for mission critical workflows. While many of the core features are in place, there are a number of rough edges that we anticipate smoothing out over the next few months. We are releasing it in this state in order to allow us to collaborate in the open with the community in order to build the best possible platform.
## Current Features
Below is a list of some of the current features. Cog is under heavy development and getting smarter all the time, but this list will give you an idea of some of the things that Cog knows how to do.
* **Extensibility**
* __Build new bot commands in any language__
* Commands return structured data to allow for creative adaptation in pipelines
* Built in templating allows the command response to be formatted for the current chat provider without embedding markup in your logic
* **Adaptability**
* Unix-style pipelines allow you to combine a series of simple commands to solve complex, unexpected problems
* Support for output redirection lets you make sure everyone is in the loop
* **Security**
* Fine-grained command permissions give you confidence in using chatops for even the most sensitive workflows
* Users, Groups, and Roles allow you to organize access control for ease of management
* Audit logging for commands and administrative functions let you keep track of everything that happens with Cog
* **Chat-provider agnostic**
* Current support for Slack with an early HipChat adapter in progress
## Resources
* [Cog Wiki](https://github.com/operable/cog/wiki)
* [GitHub Issues](https://github.com/operable/cog/issues)
* [Cog Public Chat](http://slack.operable.io/)
All documentation is currently in the [Cog Wiki](https://github.com/operable/cog/wiki).

0 comments on commit 550007b

Please sign in to comment.