Skip to content

Latest commit

 

History

History
52 lines (35 loc) · 2.2 KB

CONTRIBUTING.md

File metadata and controls

52 lines (35 loc) · 2.2 KB

Contributing to Anypoint Monitoring

Thank you for taking the time to contribute! We welcome all forms of contributions that help make this project better and more accessible. This guide explains how you can contribute to the repository and outlines the standards we aim to maintain.

Code of Conduct

Please read our Code of Conduct before contributing. All contributors are expected to adhere to the guidelines in our Code of Conduct to foster a welcoming and inclusive community.

How Can I Contribute?

Reporting Bugs

  • Check the issues to make sure the bug hasn’t already been reported.

  • If you find a new bug, open a new issue and include:

    • A clear and descriptive title.
    • Steps to reproduce the bug.
    • Expected result and actual result.
    • Relevant logs, error messages, or screenshots if applicable.

Suggesting Enhancements

  • Check the issues to see if the feature has already been requested.
  • If not, open a new feature request and include:
    • A clear and descriptive title.
    • A concise description of the enhancement.
    • Rationale for why this feature might be useful.
    • Any additional context or screenshots that might help.

Submitting Pull Requests

  • Fork the repository and create a new branch for your feature or bug fix.

    • Typically, name your branch in a descriptive way, e.g., feature/awesome-enhancement or fix/issue-123.

  • Make your changes in the new branch. Ensure you follow our Coding Guidelines and that your code meets our Commit Message Guidelines.

  • Test your changes thoroughly. Include new or updated unit tests if needed.

  • Submit a Pull Request (PR) to the main branch of this repository:

    • Add a clear title and description.
    • Reference any related issues (using #issue-number).
    • If your PR is not ready for review, mark it as a draft.

Your PR will be reviewed as soon as possible. Feedback may be provided; additional changes might be requested before the PR can be merged.

Coding Guidelines

  • Style & Formatting
    • Maintain consistency with the existing code style.
    • Use a linter if one is defined for this project.
  • Documentation
    • Update documentation (in code, README, or docs folder) for any changes that affect usage.