Skip to content

[docs] add CONTRIBUTING guidelines #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
palazzem merged 1 commit into from
Apr 17, 2018
Merged

[docs] add CONTRIBUTING guidelines #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Contributing to dd-trace-php

As an open source project we welcome contributions of many forms, but due to the experimental pre-beta nature
of this repository, you should reach out before starting work on any major code changes.
Copy link
Contributor

@jcchavezs jcchavezs Apr 17, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should describe how to reach out. What the official means are.

Copy link
Contributor Author

@palazzem palazzem Apr 17, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "official" way for now it's filling a GitHub issue with the question. We don't want to open tickets in our support platform because the current state of the tracer is Alpha and so it's expected that it doesn't work properly. I'll follow-up via GitHub if someone wants to contribute and add integrations or updating the API after some changes in OpenTracing.

This will ensure we avoid duplicating work, or that your code can't be merged due to a rapidly changing
base. If you have any questions, create a [GitHub issue][1] and reach us!

[1]: https://github.com/DataDog/dd-trace-php/issues
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@
[![OpenTracing Badge](https://img.shields.io/badge/OpenTracing-enabled-blue.svg)](http://opentracing.io)
[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%205.6-8892BF.svg)](https://php.net/)

DataDog APM client that implements an [OpenTracing](http://opentracing.io) Tracer.
Experimental PHP Tracer!

This project is experimental and under active development. Use it at your own risk.

## Installation

Expand Down Expand Up @@ -95,6 +97,8 @@ $tracer = new Tracer(

## Contributing

Before contributing to this open source project, read our [CONTRIBUTING.md](https://github.com/DataDog/dd-trace-php/blob/master/CONTRIBUTING.md).

### Run tests

```bash
Expand Down