Merge pull request #196 from maxekman/ISSUE-103/update-docs

ISSUE-103 / Update docs

AUTHORS

@@ -0,0 +1,20 @@
+# This is the list of Event Horizon authors for copyright purposes.
+#
+# This does not necessarily list everyone who has contributed code, since in
+# some cases, their employer may be the copyright holder. To see the full list
+# of contributors, see the revision history in source control.
+
+Looplab AB / Max Ekman
+Jon Warghed
+Mark Bucciarelli
+Jens Rantil
+Sonny Vidfamn
+C A Hart
+Daniel Travin
+Johnny Bergström
+Gerrit Renker
+Stefan Fuchs
+David Högborg
+Michael E Brown
+Oleg Yashchuk
+Bradley Weston

CODE_OF_CONDUCT.md

@@ -0,0 +1,73 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+education, socio-economic status, nationality, personal appearance, race,
+religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [INSERT EMAIL ADDRESS]. 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.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org

CONTRIBUTING.md

@@ -0,0 +1,66 @@
+# Contributing to Event Horizon
+
+First off, thanks for taking the time to contribute!
+
+The following is a set of guidelines for contributing to Event Horizon and its packages, which are hosted in the [Looplab Organization](https://github.com/looplab) on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
+
+#### Table Of Contents
+
+[Code of Conduct](#code-of-conduct)
+
+[How Can I Contribute?](#how-can-i-contribute)
+
+* [Reporting Bugs](#reporting-bugs)
+* [Suggesting Enhancements](#suggesting-enhancements)
+* [Pull Requests](#pull-requests)
+
+[Styleguides](#styleguides)
+
+* [Git Commit Messages](#git-commit-messages)
+* [Golang Styleguide](#golang-styleguide)
+* [Documentation Styleguide](#documentation-styleguide)
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by the [Event Horizon Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [[email protected]](mailto:[email protected]).
+
+## How Can I Contribute?
+
+### Reporting Bugs
+
+If you find a bug report it by creating a new Github issue.
+
+> **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
+
+### Suggesting Enhancements
+
+* Create a new issue with a feature suggestion to discuss it further.
+* Join our [slack channel](https://gophers.slack.com/messages/eventhorizon/) (sign up [here](https://gophersinvite.herokuapp.com/))
+
+### Pull Requests
+
+* Fill in [the required template](PULL_REQUEST_TEMPLATE.md)
+* Follow the [Golang Styleguide](#golang-styleguide)
+* Document new code based on the [Documentation Styleguide](#documentation-styleguide)
+* End all files with a newline
+
+## Styleguides
+
+### Git Commit Messages
+
+* Use the present tense ("Add feature" not "Added feature")
+* Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
+* Limit the first line to 72 characters or less
+* Reference issues and pull requests liberally after the first line
+
+### Golang Styleguide
+
+All Golang code should adhere to [Go Code Review Comments](https://github.com/golang/go/wiki/CodeReviewComments). Package imports should be ordered with a blank line between each block:
+
+* stdlib
+* 3rd party
+* internal
+
+### Documentation Styleguide
+
+Documentation should be provided in the Godoc format in the source files for all public interfaces. Other documentation should be written as Markdown files in the `docs` folder.

PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,9 @@
+# Summary
+
+# How to test
+
+# Issue
+
+Fixes #.
+
+# Notes

README.md

@@ -3,12 +3,11 @@
 [![GoDoc](https://godoc.org/github.com/looplab/eventhorizon?status.svg)](https://godoc.org/github.com/looplab/eventhorizon)
 [![Go Report Card](https://goreportcard.com/badge/looplab/eventhorizon)](https://goreportcard.com/report/looplab/eventhorizon)
 
-
 # Event Horizon
 
 Event Horizon is a CQRS/ES toolkit for Go.
 
-**Event Horizon is used in at least one production system but may not be considered stable just yet!**
+**NOTE: Event Horizon is used in production systems but the API is not final!**
 
 CQRS stands for Command Query Responsibility Segregation and is a technique where object access (the Query part) and modification (the Command part) are separated from each other. This helps in designing complex data models where the actions can be totally independent from the data output.
 
@@ -18,38 +17,59 @@ Read more about CQRS/ES from one of the major authors/contributors on the subjec
 
 Other material on CQRS/ES:
 
-- http://martinfowler.com/bliki/CQRS.html
-- http://cqrs.nu
-- https://groups.google.com/forum/#!forum/dddcqrs
+* http://martinfowler.com/bliki/CQRS.html
+* http://cqrs.nu
+* https://groups.google.com/forum/#!forum/dddcqrs
 
 Inspired by the following libraries/examples:
 
-- https://github.com/edumentab/cqrs-starter-kit
-- https://github.com/pjvds/go-cqrs
-- http://www.codeproject.com/Articles/555855/Introduction-to-CQRS
-- https://github.com/qandidate-labs/broadway
+* https://github.com/edumentab/cqrs-starter-kit
+* https://github.com/pjvds/go-cqrs
+* http://www.codeproject.com/Articles/555855/Introduction-to-CQRS
+* https://github.com/qandidate-labs/broadway
 
 Suggestions are welcome!
 
-
 # Usage
 
-See the example folder for a basic usage example to get you started.
+See the example folder for a few examples to get you started.
 
+# Storage drivers
 
-# Storage and messaging implementations
+These are the drivers for storage of events and entities.
 
-There are simple in memory implementations of all components in the toolkit (event store, read repository, event bus, command bus). Most of these are meant for testing and development, the command bus (and in some cases the event bus) could however fulfill the needs of a production system.
+### Local / in memory
 
-In addition there is MongoDB implementations of the event store and a simple read repository, and a Redis implementation of the event bus.
+There are simple in memory implementations of an event store and entity repo. These are meant for testing/experimentation.
 
-There is also experimental support for AWS DynamoDB as an event store. Support for a event bus using AWS SQS is also planned but not started.
+### MongoDB
 
+Fairly mature, used in production.
 
-# Get Involved
+### AWS DynamoDB
+
+Experimental support for AWS DynamoDB as an event store. Not actively developed.
+
+# Messaging drivers
+
+These are the drivers for messaging, currently only publishers.
+
+### Local / in memory
 
-- Join our [slack channel](https://gophers.slack.com/messages/eventhorizon/) (sign up [here](https://gophersinvite.herokuapp.com/))
+Fully synchrounos. Useful for testing/experimentation.
+
+### Redis
+
+Fairly mature, used in production.
+
+### GCP Cloud Pub/Sub
+
+Experimental driver.
+
+# Get Involved
 
+* Join our [slack channel](https://gophers.slack.com/messages/eventhorizon/) (sign up [here](https://gophersinvite.herokuapp.com/))
+* Check out the [contribution guidelines](CONTRIBUTING.md)
 
 # License
 

aggregate.go

@@ -1,4 +1,4 @@
-// Copyright (c) 2014 - Max Ekman <[email protected]>
+// Copyright (c) 2014 - The Event Horizon authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

aggregate_test.go

@@ -1,4 +1,4 @@
-// Copyright (c) 2014 - Max Ekman <[email protected]>
+// Copyright (c) 2014 - The Event Horizon authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

aggregatestore/events/aggregatebase.go

@@ -1,4 +1,4 @@
-// Copyright (c) 2014 - Max Ekman <[email protected]>
+// Copyright (c) 2014 - The Event Horizon authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

aggregatestore/events/aggregatebase_test.go

@@ -1,4 +1,4 @@
-// Copyright (c) 2014 - Max Ekman <[email protected]>
+// Copyright (c) 2014 - The Event Horizon authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

aggregatestore/events/aggregatestore.go

@@ -1,4 +1,4 @@
-// Copyright (c) 2014 - Max Ekman <[email protected]>
+// Copyright (c) 2014 - The Event Horizon authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

aggregatestore/events/aggregatestore_test.go

@@ -1,4 +1,4 @@
-// Copyright (c) 2014 - Max Ekman <[email protected]>
+// Copyright (c) 2014 - The Event Horizon authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

aggregatestore/model/aggregatestore.go

@@ -1,4 +1,4 @@
-// Copyright (c) 2017 - Max Ekman <[email protected]>
+// Copyright (c) 2017 - The Event Horizon authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

aggregatestore/model/aggregatestore_test.go

@@ -1,4 +1,4 @@
-// Copyright (c) 2017 - Max Ekman <[email protected]>
+// Copyright (c) 2017 - The Event Horizon authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

aggregatestore/model/eventpublisher.go

@@ -1,4 +1,4 @@
-// Copyright (c) 2017 - Max Ekman <[email protected]>
+// Copyright (c) 2017 - The Event Horizon authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

command.go

@@ -1,4 +1,4 @@
-// Copyright (c) 2014 - Max Ekman <[email protected]>
+// Copyright (c) 2014 - The Event Horizon authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

command_test.go

@@ -1,4 +1,4 @@
-// Copyright (c) 2016 - Max Ekman <[email protected]>
+// Copyright (c) 2016 - The Event Horizon authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

commandhandler.go

@@ -1,4 +1,4 @@
-// Copyright (c) 2014 - Max Ekman <[email protected]>
+// Copyright (c) 2014 - The Event Horizon authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

commandhandler/aggregate/commandhandler.go

@@ -1,4 +1,4 @@
-// Copyright (c) 2014 - Max Ekman <[email protected]>
+// Copyright (c) 2014 - The Event Horizon authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

commandhandler/aggregate/commandhandler_test.go

@@ -1,4 +1,4 @@
-// Copyright (c) 2014 - Max Ekman <[email protected]>
+// Copyright (c) 2014 - The Event Horizon authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

commandhandler/bus/commandhandler.go

@@ -1,4 +1,4 @@
-// Copyright (c) 2014 - Max Ekman <[email protected]>
+// Copyright (c) 2014 - The Event Horizon authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

commandhandler/bus/commandhandler_test.go

@@ -1,4 +1,4 @@
-// Copyright (c) 2014 - Max Ekman <[email protected]>
+// Copyright (c) 2014 - The Event Horizon authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

commandhandler_test.go

@@ -1,4 +1,4 @@
-// Copyright (c) 2018 - Max Ekman <[email protected]>
+// Copyright (c) 2018 - The Event Horizon authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

context.go

@@ -1,4 +1,4 @@
-// Copyright (c) 2014 - Max Ekman <[email protected]>
+// Copyright (c) 2014 - The Event Horizon authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

context_test.go

@@ -1,4 +1,4 @@
-// Copyright (c) 2016 - Max Ekman <[email protected]>
+// Copyright (c) 2016 - The Event Horizon authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

entity.go

@@ -1,4 +1,4 @@
-// Copyright (c) 2017 - Max Ekman <[email protected]>
+// Copyright (c) 2017 - The Event Horizon authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

event.go

@@ -1,4 +1,4 @@
-// Copyright (c) 2014 - Max Ekman <[email protected]>
+// Copyright (c) 2014 - The Event Horizon authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

event_test.go

@@ -1,4 +1,4 @@
-// Copyright (c) 2016 - Max Ekman <[email protected]>
+// Copyright (c) 2016 - The Event Horizon authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

eventbus.go

@@ -1,4 +1,4 @@
-// Copyright (c) 2014 - Max Ekman <[email protected]>
+// Copyright (c) 2014 - The Event Horizon authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.