Skip to content

Commit

Permalink
backed out change to CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MikePaquette committed Dec 6, 2018
1 parent b9618cf commit bce0b83
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,15 @@ The `type` is the [Elasticsearch field type](https://www.elastic.co/guide/en/ela
`example` adds an sample value.
The `phase` field indicates the development status of the field. If `phase` is left out, the default is 0.

## Phases

A field's `phase` indicates where it is in its development. Different phases exist to make it easy for you to contribute new fields, while allowing for more iteration. Here are the phases:

* 0 (alpha): The field is new and is up for discussion as to whether or not it should be added. The field might be removed at any time.
* 1 (beta): It's clear that there is value of having the field in ECS and discussions about prefixes/naming have started. It's unlikely that the field will be removed, but naming might change at any time.
* 2 (rc): The field has been accepted and is unlikely to change. It is now tested in the field.
* 3 (GA): The field is part of ECS. Any breaking changes will happen only at a major release.

## Guidelines for implementing ECS

* The document MUST have the `@timestamp` field.
Expand Down

0 comments on commit bce0b83

Please sign in to comment.