Skip to content

Latest commit

 

History

History
69 lines (44 loc) · 2.2 KB

CONTRIBUTING.md

File metadata and controls

69 lines (44 loc) · 2.2 KB
Raw

Contributing to OpenTelemetry Cheat Sheet

First off, thank you for considering contributing to the OpenTelemetry Cheat Sheet! It's people like you that make this resource valuable for the community.

How Can I Contribute?

Reporting Bugs

If you find a bug in any of the configuration examples or documentation:

  1. Use the GitHub issue search — check if the issue has already been reported.
  2. If the issue hasn't been reported, create a new issue.
  3. Clearly describe the issue, including steps to reproduce when it is a bug.

Suggesting Enhancements

If you have an idea for a new feature or an improvement:

  1. Check the GitHub issues to see if it's already been suggested.
  2. If not, create a new issue.
  3. Use a clear and descriptive title.
  4. Provide a detailed description of the suggested enhancement.
  5. Explain why this enhancement would be useful to most users.

Pull Requests

  1. Fork the repo and create your branch from master.
  2. If you've added code, add examples or tests as appropriate.
  3. Ensure your code follows the existing style.
  4. Write a good commit message.

Style Guide

YAML Files

  • Use 2 spaces for indentation.
  • Add comments to explain complex configurations.

Markdown Files

  • Use proper header hierarchy (# for main title, ## for sections, etc.).
  • Use code blocks with language specification for code snippets.
  • Keep line length to a maximum of 120 characters for better readability.

Adding New Examples

When adding new examples:

  1. Create a new directory if it's a new category.
  2. Include a README.md in the directory explaining the examples.
  3. Follow the existing naming conventions.
  4. Ensure your examples are well-commented and easy to understand.

Documentation

  • Keep the main README.md up to date with any new sections or major changes.
  • Ensure all links are working.
  • Proofread your contributions for spelling and grammar.

Community

  • Be welcoming to newcomers and encourage diverse new contributors from all backgrounds.
  • Be respectful to others in all communications.

Questions?

If you have any questions, create an issue (prefixed with [QUESTION]) or contact the project maintainers.

Thank you for contributing to the OpenTelemetry Cheat Sheet!