How to report an issue
There are various type of issues. For example, you may ask for help, report a problem or suggest a new feature. Whichever the type, a properly submitted issue is more likely to be addressed in a timely manner by the developers of a project.
How to open an issue
If you have an account on the Adaltas Gitlab:
- Go to the Adaltas Cloud repository and open a new issue.
- Fill the title.
- Choose one of the available template:
- Fill other appropriate properties and submit the issue.
Otherwise, send us an email. Include the name of the concerned account and use one of the templates below for its content. An email which does not cover the details of those templates will be disregarded.
Documentation
Summary
A clear and concise description of the proposed improvement.
Additional context
What problem(s) did you run into that caused you to request additional documentation? What questions do you think we should answer? What, if any, existing documentation relates to this proposal?
Some recommended topics to cover:
List the topics you think should be here.
This list does not need to be exhaustive!Motivation
Why should we document this and who will benefit from it?
Draft the doc
Write the documentation or the table of content.
Bug report
Summary
A clear and concise description of what the bug is.
Additional context
Add any other context about the problem here such as the OS or browser being use, the impacted services and their versions.
Steps to reproduce
How one can reproduce the issue - this is very important.
Example Project
Please provide us with a unit test, an example code or even pseudo-code that exhibits the problematic behavior. It could take the form of a pull request, a link to a repository or some inline code in the issue if the code is not too big. It could be written in any language you like, it doesn’t matter. What’s important is to limit the information to the minimum necessary to reproduce the problem.
Current bug behavior
What actually happens.
Expected correct behavior
What you should see instead.
Relevant logs and/or screenshots
Paste any relevant logs - please use some well formated Markdown including code blocks (```) to format console output, logs, and code, as it’s very hard to read otherwise.
Possible fixes
If you can, provide some fix or link to the line of code that might be responsible for the problem.
Feature request
Summary
A clear and concise description of what the feature is.
Motivation
If the feature is related to a problem, describe it. Add any other context explaining why this feature is of interest to you and the community.
Alternative
A clear and concise description of alternative solutions or features you’ve considered.
Draft
Write a proposal for the feature, how it works, its expected coverage, a sample code or unit test. If the feature is related to a documentation or article, write the content or the table of content you expect.