Skip to content

Latest commit

 

History

History
93 lines (67 loc) · 3.41 KB

CONTRIBUTING.md

File metadata and controls

93 lines (67 loc) · 3.41 KB
Raw

How to Contribute

Thanks for your interest in contributing to otelify.sh! Here are a few general guidelines on contributing and reporting bugs that we ask you to review. Following these guidelines helps to communicate that you respect the time of the contributors managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests. In that spirit of mutual respect, we endeavor to review incoming issues and pull requests within 10 days, and will close any lingering issues or pull requests after 60 days of inactivity.

Please note that all of your interactions in the project are subject to our Code of Conduct. This includes creation of issues or pull requests, commenting on issues or pull requests, and extends to all interactions in any real-time space e.g., Slack, Discord, etc.

Development

If you'd like to add a feature or fix a bug for otelify.sh, you can set up a development environment as follows.

  • Clone the repository and change into the newly created folder

    git clone https://github.com/cisco-open/otelify.sh.git
cd otelify.sh

  • Make sure you have Docker installed locally:

    docker --version

    This should return a version string like Docker version 26.1.1, build 4cf5afa. Older versions of Docker should work as well, but if you face any issues make sure to use a recent version.

  • Within the repository folder you can now execute the tests based on the Bash Automated Testing System (bats):

    ./test.sh

    All tests will run in a Docker container (see the /Dockerfile for details).

  • While developing you might want to skip the integrations tests, since they can take a while to complete, and can be easily disabled:

    ./test.sh -q

Reporting Issues

Before reporting a new issue, please ensure that the issue was not already reported or fixed by searching through our issues list.

When creating a new issue, please be sure to include a title and clear description, as much relevant information as possible, and, if possible, a test case.

If you discover a security bug, please do not report it through GitHub. Instead, please see security procedures in SECURITY.md.

Sending Pull Requests

Before sending a new pull request, take a look at existing pull requests and issues to see if the proposed change or fix has been discussed in the past, or if the change was already implemented but not yet released.

We expect new pull requests to include tests for any affected behavior, and, as we follow semantic versioning, we may reserve breaking changes until the next major version release.

Other Ways to Contribute

We welcome anyone that wants to contribute to otelify.sh to triage and reply to open issues to help troubleshoot and fix existing bugs. Here is what you can do:

  • Help ensure that existing issues follows the recommendations from the Reporting Issues section, providing feedback to the issue's author on what might be missing.
  • Review existing pull requests, and testing patches against real existing applications that use otelify.sh.
  • Write a test, or add a missing test case to an existing test.

Thanks again for your interest on contributing to otelify.sh!

❤️