Skip to content

Commit

Permalink
[docs] README includes more information about contributions
Browse files Browse the repository at this point in the history
  • Loading branch information
Kent Shultz authored and Emanuele Palazzetti committed Nov 27, 2017
1 parent fcc8510 commit 401a2fe
Showing 1 changed file with 43 additions and 8 deletions.
51 changes: 43 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,50 @@
# dd-trace-go

[![CircleCI](https://circleci.com/gh/DataDog/dd-trace-go/tree/master.svg?style=svg)](https://circleci.com/gh/DataDog/dd-trace-go/tree/master)
[![Godoc](http://img.shields.io/badge/godoc-reference-blue.svg?style=flat)](https://godoc.org/github.com/DataDog/dd-trace-go/tracer)

The Datadog go tracing package. Currently requires at least Go 1.7.
A Go tracing package for Datadog APM.

## Contributing Quick Start

Requirements:

* Go 1.7 or later
* Docker
* Rake
* gometalinter – `go get -u github.com/alecthomas/gometalinter`
* golint – `go get -u github.com/golang/lint/golint`
* goconst – `go get -u github.com/jgautheron/goconst/cmd/goconst`
* gas – `go get -u github.com/GoASTScanner/gas`
* ineffassign – `go get -u github.com/gordonklaus/ineffassign`
* gocyclo – `go get -u github.com/fzipp/gocyclo`

### Run the tests

Start the containers defined in `docker-compose.yml`:

```
$ docker-compose up -d
```

Fetch this package's dependencies:

```
$ rake get
```

This will only work if your working directory is in $GOPATH/src.

Finally, run the tests:

```
$ rake ci
```

### Create a Branch

Sample code: https://godoc.org/github.com/DataDog/dd-trace-go/tracer#pkg-examples
List of integrations: https://godoc.org/github.com/DataDog/dd-trace-go/tracer#pkg-subdirectories
???

## Directory structure
## Further Reading

- [tracer](https://github.com/DataDog/dd-trace-go/tree/master/tracer): contains the low level API used to trace the different libraries.
Automatically traced libraries and frameworks: https://godoc.org/github.com/DataDog/dd-trace-go/tracer#pkg-subdirectories
Sample code: https://godoc.org/github.com/DataDog/dd-trace-go/tracer#pkg-examples

- [contrib](https://github.com/DataDog/dd-trace-go/tree/master/contrib): contains the different libraries supported by our APM solution.

0 comments on commit 401a2fe

Please sign in to comment.