Skip to content

Latest commit

 

History

History
35 lines (25 loc) · 1.6 KB

CONTRIBUTING.md

File metadata and controls

35 lines (25 loc) · 1.6 KB
Raw

Contributing to Spring MediatR

How Can I Contribute?

Reporting Bugs

If you believe you've found a bug with Spring MediatR please feel free to open an issue. Please use the following guidelines when opening issues.

  • Use a clear and descriptive title
  • Describe the exact steps which reproduce the problem in as many details as possible. When listing steps, don't just say what you did, but explain how you did it. If possible to share the code please do as that can help significantly in debugging.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.
  • Apply the type:bug tag to the issue
  • List which version of Spring and Java you are using

Suggest Enhancement

If you have suggestions on enhancements to Spring MediatR feel free to open an issue with the tag type:enhancement.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Explain why this enhancement would be useful to most users of Spring MediatR.

Submit Pull Request

Before submitting a Pull Request please open an issue first and refer to the issues being addressed in the Pull Request.

While this library is written in Kotlin please keep in mind most Spring code bases are still Java. Any features added need to be Java friendly and take Java interoperability into consideration.