Skip to content

CONTRIBUTING.md

Latest commit

Β 

History

History
48 lines (34 loc) Β· 2.64 KB

CONTRIBUTING.md

File metadata and controls

48 lines (34 loc) Β· 2.64 KB

Contributing to mumzworld/magento2-opentelemetry

We welcome contributions to the mumzworld/magento2-opentelemetry package! Before you start, please take a moment to read this guide.

🀝 Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms. Please read our CODE_OF_CONDUCT.md.

πŸ“ Reporting Bugs

If you find a bug, please help us by submitting an issue to our GitHub repository.

  1. Search: Check existing issues to see if the bug has already been reported.
  2. Submit: Open a new issue and use the Bug Report issue template.
  3. Details: Include as much detail as possible:
    • Steps to reproduce the issue.
    • Expected vs. actual behavior.
    • Your PHP, Magento 2, and package version(s).
    • Relevant stack trace or error messages.

✨ Suggesting Features/Enhancements

We love hearing new ideas! For major features or significant changes:

  1. Discuss First: Please open an issue to discuss the feature with the maintainers before investing time in writing code. This ensures the idea aligns with the project's goals.
  2. Scope: Ensure the suggestion relates directly to OpenTelemetry integration within Magento 2.

πŸ’» Development Workflow

To contribute code, please follow these steps:

  1. Fork: Fork the mumzworld/magento2-opentelemetry repository.
  2. Clone: Clone your forked repository to your local machine.
  3. Setup: Follow the installation and setup steps detailed in the README.md.
  4. Branch: Create a new branch for your feature or fix (e.g., feature/add-trace-id or fix/error-reporting).
  5. Code: Write your code, ensuring it adheres to standard Magento 2 coding practices.
  6. Test: All contributions must include tests. If you are fixing a bug, add a failing test that is fixed by your code. If you are adding a feature, add tests to cover the new functionality.
  7. Commit: Commit your changes using clear and descriptive commit messages.

πŸš€ Submitting a Pull Request (PR)

  1. Review: Ensure your changes pass all checks.
  2. PR Details: Submit your Pull Request against the main branch of the original repository.
  3. Checklist: Ensure your PR description addresses the following:
    • Does this PR address an existing issue (link it)?
    • Does this PR include necessary tests?
    • Is the code style clean and consistent?
  4. Patience: Maintainers will review your PR as quickly as possible. We may ask for changes or clarifications. Be responsive, and thank you for your contribution!