Skip to content

Commit

Permalink
Document project structure (jaegertracing#44)
Browse files Browse the repository at this point in the history
  • Loading branch information
yurishkuro authored Feb 10, 2017
1 parent c0b80a2 commit c0b108e
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,46 @@ glide install
make test
```

## Project Structure

These are general guidelines on how to organize source code in this repository.

```
github.com/uber/jaeger
cmd/ - All binaries go here
agent/
app/ - The actual code for the binary
main.go
collector/
app/ - The actual code for the binary
main.go
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
storage/
spanstore/ - SpanReader / SpanWriter interfaces
dependencystore/
idl/ - (submodule)
jaeger-ui/ - (submodule)
thrift-gen/ - Generated Thrift types
agent/
jaeger/
sampling/
zipkincore/
```

* Note 1: `pkg` is a collection of utility packages used by the Jaeger components
without being specific to its internals. Utility packages are kept separate from
the Jaeger core codebase to keep it as small and concise as possible. If some
utilities grow larger and their APIs stabilize, they may be moved to their own
repository, to facilitate re-use by other projects.


## Making A Change

*Before making any significant changes, please [open an
Expand Down

0 comments on commit c0b108e

Please sign in to comment.