|
| 1 | +# Contributing to Merlin Framework |
| 2 | + |
| 3 | +Thanks for taking the time to contribute! |
| 4 | + |
| 5 | +#### Table of contents |
| 6 | + |
| 7 | +[How can I contribute?](#how-can-i-contribute) |
| 8 | + * [Reporting bugs](#reporting-bugs) |
| 9 | + * [Before submitting a bug report](#before-submitting-a-bug-report) |
| 10 | + * [What makes a good bug report?](#what-makes-a-good-bug-report) |
| 11 | + * [Suggesting enhancements](#suggesting-enhancements) |
| 12 | + * [Your first code contribution](#your-first-code-contribution) |
| 13 | + * [Pull requests](#pull-requests) |
| 14 | + |
| 15 | +## How can I contribute? |
| 16 | + |
| 17 | +### Reporting bugs |
| 18 | + |
| 19 | +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. |
| 20 | + |
| 21 | +Before creating a bug report, please check [the issue list](https://github.com/salsadigitalauorg/merlin-framework/issues) 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. |
| 22 | + |
| 23 | +>>> **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. |
| 24 | +
|
| 25 | +#### Before submitting a bug report |
| 26 | + |
| 27 | +* **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. |
| 28 | + |
| 29 | +#### What makes a good bug report? |
| 30 | + |
| 31 | +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: |
| 32 | + |
| 33 | +* **Use a clear and descriptive title** for the issue to identify the problem. |
| 34 | +* **Provide the configuration that caused the problem** as this will allow the maintainers to quickly dive into the issue and find the cause. |
| 35 | +* **Describe the behaviour observed** and point out exactly what the problems with that behaviour. |
| 36 | +* **Explain what behaviour is expected**. |
| 37 | +* **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. |
| 38 | + |
| 39 | + |
0 commit comments