Added SourceChangeSubmitted documentation.

README.md

@@ -27,7 +27,7 @@ __IMPORTANT NOTICE:__ The contents of this repository currectly reflect a __DRAF
    1. EiffelEnvironmentDefinedEvent
    1. EiffelCompositionDefinedEvent
    1. EiffelSourceChangeCreatedEvent
-   1. EiffelSourceChangeSubmittedEvent
+   1. [EiffelSourceChangeSubmittedEvent](./eiffel-vocabulary/EiffelSourceChangeSubmittedEvent.md)
    1. EiffelFlowContextDefinedEvent
    1. EiffelTestCaseStartedEvent
    1. EiffelTestCaseFinishedEvent

eiffel-vocabulary/EiffelSourceChangeSubmittedEvent.md

@@ -0,0 +1,130 @@
+# EiffelSourceChangeSubmittedEvent
+The EiffelSourceChangeSubmittedEvent declares that a change has been integrated into to a shared source branch of interest (e.g. "master", "dev" or "mainline") as opposed to a private or local branch. Note that it does not describe what has changed, but instead uses __links.change__ to reference [EiffelSourceChangeCreatedEvent](./EiffelSourceChangeCreatedEvent.md).
+
+Typical use cases for EiffelSourceChangeSubmittedEvent is to signal that a patch has passed code review and been submitted or that a feature/topic/team branch has been merged into the mainline/trunk/master. Where changes are made directly on the mainline, it is recommended to send both [EiffelSourceChangeCreatedEvent](./EiffelSourceChangeCreatedEvent.md) and EiffelSourceChangeSubmittedEvent together for information completeness.
+
+Even though multiple types of identifiers are available (see below), the event SHOULD include one and SHALL not include more than one; changes to multiple repositories are represented by multiple events.
+
+## Data Members
+### data.submitter
+__Type:__ Object  
+__Required:__ No  
+__Description:__ The agent (individual, group or machine) submitting the change. This is crucially different from the __data.author__ field of [EiffelSourceChangeCreatedEvent](./EiffelSourceChangeCreatedEvent.md).
+
+#### data.submitter.name
+__Type:__ String  
+__Required:__ No  
+__Description:__ The name of the author.
+
+#### data.submitter.email
+__Type:__ String  
+__Required:__ No  
+__Description:__ The email address of the author.
+
+#### data.submitter.id
+__Type:__ String  
+__Required:__ No  
+__Description:__ Any identity, username or alias of the author.
+
+#### data.submitter.group
+__Type:__ String  
+__Required:__ No  
+__Description:__ Any group or organization to which the contributor belongs.
+
+### data.gitIdentifier
+__Type:__ Object  
+__Required:__ No  
+__Description:__ Identifier of a Git change.
+
+#### data.gitIdentifier.commitId
+__Type:__ String  
+__Required:__ Yes  
+__Description:__ The commit identity (hash) of the change.
+
+#### data.gitIdentifier.branch  
+__Type:__ String  
+__Required:__ No  
+__Description:__ The name of the branch where the change was made.
+
+#### data.gitIdentifier.repoName  
+__Type:__ String  
+__Required:__ No  
+__Description:__ The name of the repository containing the change.
+
+#### data.gitIdentifier.repoUri  
+__Type:__ String  
+__Required:__ Yes  
+__Description:__ The URI of the repository containing the change.
+
+### data.svnIdentifier
+__Type:__ Object  
+__Required:__ No  
+__Description:__ Identifier of a Subversion change.
+
+#### data.svnIdentifier.revision
+__Type:__ Integer  
+__Required:__ Yes  
+__Description:__ The revision of the change.
+
+#### data.svnIdentifier.directory  
+__Type:__ String  
+__Required:__ Yes  
+__Description:__ The directory (branch/tag) of the change.
+
+#### data.svnIdentifier.repoName  
+__Type:__ String  
+__Required:__ No  
+__Description:__ The name of the repository containing the change.
+
+#### data.svnIdentifier.repoUri  
+__Type:__ String  
+__Required:__ Yes  
+__Description:__ The URI of the repository containing the change.
+
+### data.ccCompositeIdentifier
+__Type:__ Object  
+__Required:__ No  
+__Description:__ Identifier of a composite ClearCase change – in other words, not single file commit, but analogous of repository-wide commits of e.g. SVN or Git.
+
+#### data.ccCompositeIdentifier.vob
+__Type:__ String  
+__Required:__ Yes  
+__Description:__ The ClearCase VOB name.
+
+#### data.ccCompositeIdentifier.branch
+__Type:__ String  
+__Required:__ Yes  
+__Description:__ The branch of the change.
+
+#### data.ccCompositeIdentifier.configSpec
+__Type:__ String  
+__Required:__ Yes  
+__Description:__ The URI of the relevant ClearCase config spec.
+
+### data.hgIdentifier
+__Type:__ Object  
+__Required:__ No  
+__Description:__ Identifier of a Mercurial change.
+
+#### data.hgIdentifier.commitId
+__Type:__ String  
+__Required:__ Yes  
+__Description:__ The commit identity (hash) of the change.
+
+#### data.hgIdentifier.branch
+__Type:__ String  
+__Required:__ No  
+__Description:__ The branch of the change.
+
+#### data.hgIdentifier.repoName
+__Type:__ String  
+__Required:__ No  
+__Description:__ The name of the repo.
+
+#### data.hgIdentifier.repoUri
+__Type:__ String  
+__Required:__ Yes  
+__Description:__ The URI of the repo.
+
+## Examples
+* [Simple example](https://github.com/Ericsson/eiffel-examples/blob/master/events/EiffelSourceChangeSubmittedEvent/simple.json)