Skip to content

Commit

Permalink
Update project structure guidelines in CONTRIBUTING.md (#498)
Browse files Browse the repository at this point in the history
Added missing directories and descriptions to the project structure general guidelines section.
  • Loading branch information
Allie Crevier authored and yurishkuro committed Oct 31, 2017
1 parent 06067cb commit abaa65a
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,24 +51,33 @@ github.com/uber/jaeger
collector/
app/ - The actual code for the binary
main.go
pkg/ - See Note 1
crossdock/ - Cross-repo integration test configuration
 docs/ - Documentation
examples/
hotrod/ - Demo application that uses OpenTracing API
idl/ - (submodule) https://github.com/jaegertracing/jaeger-idl
jaeger-ui/ - (submodule) https://github.com/jaegertracing/jaeger-ui
model/ - Where models are kept, e.g. Process, Span, Trace
pkg/ - (See Note 1)
plugin/ - Swappable implementations of various components
storage/
cassandra/ - Cassandra implementations of storage APIs
. - Shared Cassandra stuff
spanstore/ - SpanReader / SpanWriter implementations
dependencystore/
elasticsearch/ - ES implementations of storage APIs
scripts/ - Miscellaneous project scripts, e.g. license update script
storage/
spanstore/ - SpanReader / SpanWriter interfaces
dependencystore/
idl/ - (submodule)
jaeger-ui/ - (submodule)
thrift-gen/ - Generated Thrift types
agent/
jaeger/
sampling/
zipkincore/
travis/ - Travis scripts called in .travis.yml
glide.yaml - Glide is the project's dependency manager
mkdocs.yml - MkDocs builds the documentation in docs/
```

* Note 1: `pkg` is a collection of utility packages used by the Jaeger components
Expand Down

0 comments on commit abaa65a

Please sign in to comment.