Skip to content

Latest commit

 

History

History
39 lines (24 loc) · 2.16 KB

CONTRIBUTING.md

File metadata and controls

39 lines (24 loc) · 2.16 KB

Contributing to Merlin Framework

Thanks for taking the time to contribute!

Table of contents

How can I contribute?

How can I contribute?

Reporting bugs

This section guides you through creating and submitting a bug report. Following these guidelines helps maintainers and the community understand your report, reporoduce the behaviour and fix the problems.

Before creating a bug report, please check the issue list and make sure that it is not something planned or raised before. When you are creating a bug report, please include as many details as possible and fill out the required template, it will help us resolve issues faster.

Note: If you find a closed issue that seems like it is the same as what you're experiencing please open a new issue and include a link to the original issue.

Before submitting a bug report

  • Check the issue queue to see if the problem has been previously reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.

What makes a good bug report?

Bugs are tracked using the Github issue queue. When creating a new bug report explain the problem and include as much detail as possible to help maintainers reproduce the problem:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Provide the configuration that caused the problem as this will allow the maintainers to quickly dive into the issue and find the cause.
  • Describe the behaviour observed and point out exactly what the problems with that behaviour.
  • Explain what behaviour is expected.
  • If the problem wasn't triggered by a specific user acount describe what you were doing before the problem happened and share as much information as you can.